Layer2.Ppp.NetworkControl.Ipcp Class Reference

Internet Protocol Control Protocol. More...

Methods
	Close
	Perform an administrative close on the IPCP protocol. More...
	Description.Get
	Returns a textual description of the object.
	Destructor
	IpAddress.Get
	Returns local the IPv4 address. More...
	IpAddress.PeerProvided
	Request the peer to provide an IP address. More...
	IpAddress.Remote.Get
	Returns the IP address of the remote peer. More...
	IpAddress.Set ipAddress
	Configures the IPv4 address to be used at the local end of the link. More...
	Open
	Perform an administrative open on the IPCP protocol. More...
	Parent.Get
	Returns the parent object.

Class overview

Internet Protocol Control Protocol.

Internet Protocol Control Protocol (IPCP) is a network control protocol for establishing and configuring Internet Protocol over a Point-to-Point Protocol link. IPCP is responsible for configuring, enabling, and disabling the IP protocol modules on both ends of the point-to-point link. IPCP uses the same packet exchange mechanism as the Link Control Protocol.

The implementation is conform RFC1332

Note

1. The RFC deprecated the IP-Addresses configuration option. ByteBlower does not provide the (optional) backward compatibility for this option.
2. IP compression is not supported.

Since

2.5.0

Definition at line 5350 of file api.tcl.

Method documentation

Layer2.Ppp.NetworkControl.Ipcp::Close

Perform an administrative close on the IPCP protocol.

This event indicates that the link is not available for traffic.

In the closed state, the protocol will not come up when the PPP session is established. When the PPP/IPCP session was already established, the IPCP session will properly terminate the network layer.

See also RFC1661, section 4.3 (RFC1661, page 17) for detailed information about the Close event.

Definition at line 5362 of file api.tcl.

Layer2.Ppp.NetworkControl.Ipcp::Destructor

Warning

This object cannot be destroyed. An exception will be thrown when this method is called.

Definition at line 5373 of file api.tcl.

Layer2.Ppp.NetworkControl.Ipcp::IpAddress.Get

Returns local the IPv4 address.

This method returns the IP address to be used at the local end of the link. Before the IPCP protocol negotiated the IP address, this method will return the value configured with IpAddress.Set. After IP address negotiation with the remote peer, the method will return the IP address negotiated with the remote peer.

The latter will be either:

• the same as the value configured with IpAddress.Set:
  • if the remote peer accepted that address.
• the address imposed by the remote peer:
  • if we requested that the peer provides the address
  • when the remote peer did not accept the requested IP address.

Returns

The IP address to be used by the local peer.

Example

$ipcp IpAddress.Get

Returns:

172.16.0.63  

Definition at line 5389 of file api.tcl.

Layer2.Ppp.NetworkControl.Ipcp::IpAddress.PeerProvided

Request the peer to provide an IP address.

During IP address negotiation, we will request to peer to provide an IP address.

Note

This method call will have the same effect as calling IpAddress.Set with <ipAddress> set to '0.0.0.0'.

Example

$ipcp IpAddress.PeerProvided

Definition at line 5403 of file api.tcl.

Layer2.Ppp.NetworkControl.Ipcp::IpAddress.Remote.Get

Returns the IP address of the remote peer.

This method will return the IP address which has been requested by the remote peer during (the last) address negotiation.

Returns

IP address of the remote peer of the last address negotiation. '0.0.0.0' if no negotiation took place yet.

Example

$ipcp IpAddress.Remote.Get

Returns:

172.16.0.1  

Definition at line 5417 of file api.tcl.

Layer2.Ppp.NetworkControl.Ipcp::IpAddress.Set			ipAddress

Configures the IPv4 address to be used at the local end of the link.

During IP address negotiation, the given address will be proposed to the remote end of the link.

Parameters

ipAddress

The IPv4 address to be used during negotiation at the local peer.

Note

The IPv4 address '0.0.0.0' has a special meaning: This will request the remote peer to provide an IP address. See also IpAddress.PeerProvided for a convenience method.

Exceptions

BadIPv4Address

When an incorrect IPv4 address string was provided.

Example

$ipcp IpAddress.Set "172.16.0.63"

Definition at line 5433 of file api.tcl.

Layer2.Ppp.NetworkControl.Ipcp::Open

Perform an administrative open on the IPCP protocol.

This event indicates that the link is administratively available for traffic.

In the opened state, the protocol will come up when the PPP session is established. When the PPP/IPCP session was already established, the IPCP will start negotiation.

See also RFC1661, section 4.3 (RFC1661, page 17) for detailed information about the Open event.

Definition at line 5445 of file api.tcl.