Sergey Pastor / 1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

ipv6cp.h File Reference
Enumerations | Functions

ipv6cp.h File Reference

IPV6CP (PPP IPv6 Control Protocol) More...

Go to the source code of this file.

Enumerations

enum  Ipv6cpOptionType { IPV6CP_OPTION_INTERFACE_ID = 1, IPV6CP_OPTION_IPV6_COMP_PROTOCOL = 2 }
 

IPV6CP option types.

More...

Functions

error_t ipv6cpOpen (PppContext *context)
 IPV6CP Open event.
error_t ipv6cpClose (PppContext *context)
 IPV6CP Close event.
void ipv6cpTick (PppContext *context)
 IPV6CP timer handler.
void ipv6cpProcessPacket (PppContext *context, const PppPacket *packet, size_t length)
 Process an incoming IPV6CP packet.
error_t ipv6cpProcessConfigureReq (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Process Configure-Request packet.
error_t ipv6cpProcessConfigureAck (PppContext *context, const PppConfigurePacket *configureAckPacket)
 Process Configure-Ack packet.
error_t ipv6cpProcessConfigureNak (PppContext *context, const PppConfigurePacket *configureNakPacket)
 Process Configure-Nak packet.
error_t ipv6cpProcessConfigureReject (PppContext *context, const PppConfigurePacket *configureRejPacket)
 Process Configure-Reject packet.
error_t ipv6cpProcessTerminateReq (PppContext *context, const PppTerminatePacket *terminateReqPacket)
 Process Terminate-Request packet.
error_t ipv6cpProcessTerminateAck (PppContext *context, const PppTerminatePacket *terminateAckPacket)
 Process Terminate-Ack packet.
error_t ipv6cpProcessCodeRej (PppContext *context, const PppCodeRejPacket *codeRejPacket)
 Process Code-Reject packet.
error_t ipv6cpProcessUnknownCode (PppContext *context, const PppPacket *packet)
 Process packet with unknown code.
void ipv6cpThisLayerUp (PppContext *context)
 This-Layer-Up callback function.
void ipv6cpThisLayerDown (PppContext *context)
 This-Layer-Down callback function.
void ipv6cpThisLayerStarted (PppContext *context)
 This-Layer-Started callback function.
void ipv6cpThisLayerFinished (PppContext *context)
 This-Layer-Finished callback function.
void ipv6cpInitRestartCount (PppContext *context, uint_t value)
 Initialize-Restart-Count callback function.
void ipv6cpZeroRestartCount (PppContext *context)
 Zero-Restart-Count callback function.
error_t ipv6cpSendConfigureReq (PppContext *context)
 Send-Configure-Request callback function.
error_t ipv6cpSendConfigureAck (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Ack callback function.
error_t ipv6cpSendConfigureNak (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Nak callback function.
error_t ipv6cpSendConfigureRej (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Reject callback function.
error_t ipv6cpSendTerminateReq (PppContext *context)
 Send-Terminate-Request callback function.
error_t ipv6cpSendTerminateAck (PppContext *context, const PppTerminatePacket *terminateReqPacket)
 Send-Terminate-Ack callback function.
error_t ipv6cpSendCodeRej (PppContext *context, const PppPacket *packet)
 Send-Code-Reject callback function.
error_t ipv6cpParseOption (PppContext *context, PppOption *option, size_t inPacketLen, PppConfigurePacket *outPacket)
 Parse IPV6CP configuration option.
error_t ipv6cpParseInterfaceIdOption (PppContext *context, Ipv6cpInterfaceIdOption *option, PppConfigurePacket *outPacket)
 Parse Interface-Identifier option.

Detailed Description

IPV6CP (PPP IPv6 Control Protocol)

License

Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author:
Oryx Embedded SARL (www.oryx-embedded.com)
Version:
1.7.6

Definition in file ipv6cp.h.

Enumeration Type Documentation

enum Ipv6cpOptionType

IPV6CP option types.

Enumerator:
IPV6CP_OPTION_INTERFACE_ID 

Interface-Identifier.

IPV6CP_OPTION_IPV6_COMP_PROTOCOL 

IPv6-Compression-Protocol.

Definition at line 41 of file ipv6cp.h.

Function Documentation

error_t ipv6cpClose ( PppContext *  context )

IPV6CP Close event.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 96 of file ipv6cp.c.

void ipv6cpInitRestartCount ( PppContext *  context,
uint_t  value 
)

Initialize-Restart-Count callback function.

Parameters:
[in]contextPPP context
[in]valueRestart counter value

Definition at line 677 of file ipv6cp.c.

error_t ipv6cpOpen ( PppContext *  context )

IPV6CP Open event.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 75 of file ipv6cp.c.

error_t ipv6cpParseInterfaceIdOption ( PppContext *  context,
Ipv6cpInterfaceIdOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Interface-Identifier option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 979 of file ipv6cp.c.

error_t ipv6cpParseOption ( PppContext *  context,
PppOption *  option,
size_t  inPacketLen,
PppConfigurePacket *  outPacket 
)

Parse IPV6CP configuration option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[in]inPacketLenRemaining bytes to process in the incoming packet
[out]outPacketPointer to the Configure-Ack, Nak or Reject packet
Returns:
Error code

Definition at line 927 of file ipv6cp.c.

error_t ipv6cpProcessCodeRej ( PppContext *  context,
const PppCodeRejPacket *  codeRejPacket 
)

Process Code-Reject packet.

Parameters:
[in]contextPPP context
[in]codeRejPacketPacket received from the peer
Returns:
Error code

Definition at line 510 of file ipv6cp.c.

error_t ipv6cpProcessConfigureAck ( PppContext *  context,
const PppConfigurePacket *  configureAckPacket 
)

Process Configure-Ack packet.

Parameters:
[in]contextPPP context
[in]configureAckPacketPacket received from the peer
Returns:
Error code

Definition at line 320 of file ipv6cp.c.

error_t ipv6cpProcessConfigureNak ( PppContext *  context,
const PppConfigurePacket *  configureNakPacket 
)

Process Configure-Nak packet.

Parameters:
[in]contextPPP context
[in]configureNakPacketPacket received from the peer
Returns:
Error code

Definition at line 346 of file ipv6cp.c.

error_t ipv6cpProcessConfigureReject ( PppContext *  context,
const PppConfigurePacket *  configureRejPacket 
)

Process Configure-Reject packet.

Parameters:
[in]contextPPP context
[in]configureRejPacketPacket received from the peer
Returns:
Error code

Definition at line 409 of file ipv6cp.c.

error_t ipv6cpProcessConfigureReq ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Process Configure-Request packet.

Parameters:
[in]contextPPP context
[in]configureReqPacketPacket received from the peer
Returns:
Error code

Definition at line 224 of file ipv6cp.c.

void ipv6cpProcessPacket ( PppContext *  context,
const PppPacket *  packet,
size_t  length 
)

Process an incoming IPV6CP packet.

Parameters:
[in]contextPPP context
[in]packetIPV6CP packet received from the peer
[in]lengthLength of the packet, in bytes

Definition at line 150 of file ipv6cp.c.

error_t ipv6cpProcessTerminateAck ( PppContext *  context,
const PppTerminatePacket *  terminateAckPacket 
)

Process Terminate-Ack packet.

Parameters:
[in]contextPPP context
[in]terminateAckPacketPacket received from the peer
Returns:
Error code

Definition at line 487 of file ipv6cp.c.

error_t ipv6cpProcessTerminateReq ( PppContext *  context,
const PppTerminatePacket *  terminateReqPacket 
)

Process Terminate-Request packet.

Parameters:
[in]contextPPP context
[in]terminateReqPacketPacket received from the peer
Returns:
Error code

Definition at line 465 of file ipv6cp.c.

error_t ipv6cpProcessUnknownCode ( PppContext *  context,
const PppPacket *  packet 
)

Process packet with unknown code.

Parameters:
[in]contextPPP context
[in]packetUn-interpretable packet received from the peer
Returns:
Error code

Definition at line 557 of file ipv6cp.c.

error_t ipv6cpSendCodeRej ( PppContext *  context,
const PppPacket *  packet 
)

Send-Code-Reject callback function.

Parameters:
[in]contextPPP context
[in]packetUn-interpretable packet received from the peer
Returns:
Error code

Definition at line 905 of file ipv6cp.c.

error_t ipv6cpSendConfigureAck ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Send-Configure-Ack callback function.

Parameters:
[in]contextPPP context
[in]configureReqPacketConfigure-Request packet received from the peer
Returns:
Error code

Definition at line 783 of file ipv6cp.c.

error_t ipv6cpSendConfigureNak ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Send-Configure-Nak callback function.

Parameters:
[in]contextPPP context
[in]configureReqPacketConfigure-Request packet received from the peer
Returns:
Error code

Definition at line 802 of file ipv6cp.c.

error_t ipv6cpSendConfigureRej ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Send-Configure-Reject callback function.

Parameters:
[in]contextPPP context
[in]configureReqPacketConfigure-Request packet received from the peer
Returns:
Error code

Definition at line 821 of file ipv6cp.c.

error_t ipv6cpSendConfigureReq ( PppContext *  context )

Send-Configure-Request callback function.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 713 of file ipv6cp.c.

error_t ipv6cpSendTerminateAck ( PppContext *  context,
const PppTerminatePacket *  terminateReqPacket 
)

Send-Terminate-Ack callback function.

Parameters:
[in]contextPPP context
[in]terminateReqPacketTerminate-Request packet received from the peer
Returns:
Error code

Definition at line 871 of file ipv6cp.c.

error_t ipv6cpSendTerminateReq ( PppContext *  context )

Send-Terminate-Request callback function.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 839 of file ipv6cp.c.

void ipv6cpThisLayerDown ( PppContext *  context )

This-Layer-Down callback function.

Parameters:
[in]contextPPP context

Definition at line 625 of file ipv6cp.c.

void ipv6cpThisLayerFinished ( PppContext *  context )

This-Layer-Finished callback function.

Parameters:
[in]contextPPP context

Definition at line 664 of file ipv6cp.c.

void ipv6cpThisLayerStarted ( PppContext *  context )

This-Layer-Started callback function.

Parameters:
[in]contextPPP context

Definition at line 652 of file ipv6cp.c.

void ipv6cpThisLayerUp ( PppContext *  context )

This-Layer-Up callback function.

Parameters:
[in]contextPPP context

Definition at line 577 of file ipv6cp.c.

void ipv6cpTick ( PppContext *  context )

IPV6CP timer handler.

This routine must be periodically called by the TCP/IP stack to manage retransmissions

Parameters:
[in]contextPPP context

Definition at line 120 of file ipv6cp.c.

void ipv6cpZeroRestartCount ( PppContext *  context )

Zero-Restart-Count callback function.

Parameters:
[in]contextPPP context

Definition at line 692 of file ipv6cp.c.

Generated on Tue Jul 12 2022 17:10:20 by  doxygen 1.7.2