class RawSocket

A base class for raw socket I/O communication. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods


Detailed Description

Each protocol 'registers' for socket I/O and gets assigned one object of this class.

 RawSocket (EventLoop& eventloop, int init_family, uint8_t ip_protocol, const IfTree& iftree)

RawSocket

Constructor for a given address family and protocol.

Parameters:

eventloopthe event loop to use.
init_familythe address family.
ip_protocolthe IP protocol number (IPPROTO_*).
iftreethe interface tree.
 ~RawSocket ()

~RawSocket

[virtual]

Destructor

EventLoop&  eventloop ()

eventloop

Get the event loop.

Returns: the event loop.

int  family ()

family

[const]

Get the address family.

Returns: the address family.

int  start (string& error_msg)

start

Start the RawSocket.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  stop (string& error_msg)

stop

Stop the RawSocket.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  ip_protocol ()

ip_protocol

[const]

Get the IP protocol number.

Returns: the IP protocol number.

int  enable_ip_hdr_include (bool is_enabled, string& error_msg)

enable_ip_hdr_include

Enable/disable the "Header Included" option (for IPv4) on the protocol socket.

If enabled, the IP header of a raw packet should be created by the application itself, otherwise the kernel will build it. Note: used only for IPv4. In RFC-3542, IPV6_PKTINFO has similar functions, but because it requires the interface index and outgoing address, it is of little use for our purpose. Also, in RFC-2292 this option was a flag, so for compatibility reasons we better not set it here; instead, we will use sendmsg() to specify the header's field values.

Parameters:

is_enabledif true, enable the option, otherwise disable it.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  enable_recv_pktinfo (bool is_enabled, string& error_msg)

enable_recv_pktinfo

Enable/disable receiving information about a packet received on the protocol socket.

If enabled, values such as interface index, destination address and IP TTL (a.k.a. hop-limit in IPv6), and hop-by-hop options will be received as well.

Parameters:

is_enabledif true, set the option, otherwise reset it.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_multicast_ttl (int ttl, string& error_msg)

set_multicast_ttl

Set the default TTL (or hop-limit in IPv6) for the outgoing multicast packets on the protocol socket.

Parameters:

ttlthe desired IP TTL (a.k.a. hop-limit in IPv6) value.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  enable_multicast_loopback (bool is_enabled, string& error_msg)

enable_multicast_loopback

Enable/disable the "Multicast Loop" flag on the protocol socket.

If the multicast loopback flag is enabled, a multicast datagram sent on that socket will be delivered back to this host (assuming the host is a member of the same multicast group).

Parameters:

is_enabledif true, enable the loopback, otherwise disable it.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_default_multicast_interface (const string& if_name, const string& vif_name, string& error_msg)

set_default_multicast_interface

Set default interface for outgoing multicast on the protocol socket.

Parameters:

if_namethe name of the interface that would become the default multicast interface.
vif_namethe name of the vif that would become the default multicast interface.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  join_multicast_group (const string& if_name, const string& vif_name, const IPvX& group, string& error_msg)

join_multicast_group

Join a multicast group on an interface.

Parameters:

if_namethe name of the interface to join the multicast group.
vif_namethe name of the vif to join the multicast group.
groupthe multicast group to join.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  leave_multicast_group (const string& if_name, const string& vif_name, const IPvX& group, string& error_msg)

leave_multicast_group

Leave a multicast group on an interface.

Parameters:

if_namethe name of the interface to leave the multicast group.
vif_namethe name of the vif to leave the multicast group.
groupthe multicast group to leave.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  proto_socket_write (const string& if_name, const string& vif_name, const IPvX& src_address, const IPvX& dst_address, int32_t ip_ttl, int32_t ip_tos, bool ip_router_alert, const vector<uint8_t>& payload, string& error_msg)

proto_socket_write

Send a packet on a raw socket.

Parameters:

if_namethe interface to send the packet on. It is essential for multicast. In the unicast case this field may be empty.
vif_namethe vif to send the packet on. It is essential for multicast. In the unicast case this field may be empty.
src_addressthe IP source address.
dst_addressthe IP destination address.
ip_ttlthe IP TTL (hop-limit). If it has a negative value, the TTL will be set internally before transmission.
ip_tosthe Type Of Service (Diffserv/ECN bits for IPv4 or IP traffic class for IPv6). If it has a negative value, the TOS will be set internally before transmission.
ip_router_alertif true, then add the IP Router Alert option to the IP packet.
payloadthe payload, everything after the IP header and options.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

void  process_recv_data (const string& if_name, const string& vif_name, const IPvX& src_address, const IPvX& dst_address, int32_t ip_ttl, int32_t ip_tos, bool ip_router_alert, const vector<uint8_t>& payload)

process_recv_data

[pure virtual]

Received a packet from a raw socket.

This is a pure virtual method that must be implemented in the class that inherits from this class.

Parameters:

if_namethe interface name the packet arrived on.
vif_namethe vif name the packet arrived on.
src_addressthe IP source address.
dst_addressthe IP destination address.
ip_protocolthe IP protocol number.
ip_ttlthe IP TTL (hop-limit). If it has a negative value, then the received value is unknown.
ip_tosThe type of service (Diffserv/ECN bits for IPv4). If it has a negative value, then the received value is unknown.
ip_router_alertif true, the IP Router Alert option was included in the IP packet.
packetthe payload, everything after the IP header and options.
bool  find_interface_vif_by_name ( const string& if_name, const string& vif_name, const IfTreeInterface*& iftree_if, const IfTreeVif*& iftree_vif)

find_interface_vif_by_name

[const]

Find an interface and a vif by interface and vif name.

Parameters:

if_namethe interface name.
vif_namethe vif name.
iftree_ifreturn-by-reference a pointer to the interface.
iftree_vifreturn-by-reference a pointer to the vif.

Returns: true if a match is found, otherwise false.

bool  find_interface_vif_by_pif_index ( uint32_t pif_index, const IfTreeInterface*& iftree_if, const IfTreeVif*& iftree_vif)

find_interface_vif_by_pif_index

[const]

Find an interface and a vif by physical interface index.

Parameters:

pif_indexthe physical interface index.
iftree_ifreturn-by-reference a pointer to the interface.
iftree_vifreturn-by-reference a pointer to the vif.

Returns: true if a match is found, otherwise false.

bool  find_interface_vif_same_subnet_or_p2p ( const IPvX& addr, const IfTreeInterface*& iftree_if, const IfTreeVif*& iftree_vif)

find_interface_vif_same_subnet_or_p2p

[const]

Find an interface and a vif by an address that shares the same subnet or p2p address.

Parameters:

addrthe address.
iftree_ifreturn-by-reference a pointer to the interface.
iftree_vifreturn-by-reference a pointer to the vif.

Returns: true if a match is found, otherwise false.

bool  find_interface_vif_by_addr ( const IPvX& addr, const IfTreeInterface*& iftree_if, const IfTreeVif*& iftree_vif)

find_interface_vif_by_addr

[const]

Find an interface and a vif by an address that belongs to that interface and vif.

Parameters:

addrthe address.
iftree_ifreturn-by-reference a pointer to the interface.
iftree_vifreturn-by-reference a pointer to the vif.

Returns: true if a match is found, otherwise false.


Generated by: pavlin on possum.icir.org on Thu Mar 9 04:43:06 2006, using kdoc $.