class ProtoComm A class for socket I/O communication. More... Definition #include <mfea_proto_comm.hh> Inherits ProtoUnit (libproto) [public ] List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  ProtoComm (MfeaNode& mfea_node, int ipproto, xorp_module_id module_id)
• virtual  ~ProtoComm ()
• int  start ()
• int  stop ()
• int  proto_socket () const
• int  open_proto_socket ()
• int  close_proto_socket ()
• int  ip_hdr_include (bool enable_bool)
• int  recv_pktinfo (bool enable_bool)
• int  set_mcast_ttl (int ttl)
• int  set_multicast_loop (bool enable_bool)
• int  set_default_multicast_vif (uint16_t vif_index)
• int  join_multicast_group (uint16_t vif_index, const IPvX& group)
• int  leave_multicast_group (uint16_t vif_index, const IPvX& group)
• void  proto_socket_read (int fd, SelectorMask m)
• int  proto_socket_write (uint16_t vif_index, const IPvX& src, const IPvX& dst, int ip_ttl, int ip_tos, bool router_alert_bool, const uint8_t *databuf, size_t datalen)
• void  set_ignore_my_packets (bool v)
• xorp_module_id  module_id () const

Detailed Description

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

Constructor for given MFEA node, IP protocol, and module ID (xorp_module_id).

Parameters:

mfea_node	the MFEA node (MfeaNode) this entry belongs to.
ipproto	the IP protocol number (e.g., IPPROTO_PIM for PIM).
module_id	the module ID (xorp_module_id) for the protocol.

[virtual]

Destructor

Start the ProtoComm.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Stop the ProtoComm.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[const]

Get the protocol socket.

The protocol socket is specific to the particular protocol of this entry.

Returns: the socket value if valid, otherwise XORP_ERROR.

Open an protocol socket.

The protocol socket is specific to the particular protocol of this entry.

Returns: the socket value on success, otherwise XORP_ERROR.

Close the protocol socket.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Set/reset the "Header Included" option (for IPv4) on the protocol socket.

If set, 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 post-RFC-2292, 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:

enable_bool

if true, set the option, otherwise reset it.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Enable/disable receiving information about some of the fields in the IP header 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. Note: used only for IPv6. In IPv4 we don't have this; the whole IP packet is passed to the application listening on a raw socket.

Parameters:

enable_bool

if true, set the option, otherwise reset it.

Returns: XORP_OK on success, otherwise XORP_ERROR.

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

Parameters:

ttl	the desired IP TTL (a.k.a. hop-limit in IPv6) value.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Set/reset the "Multicast Loop" flag on the protocol socket.

If the multicast loopback flag is set, 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:

enable_bool

if true, set the loopback, otherwise reset it.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Set default interface for outgoing multicast on the protocol socket.

Parameters:

vif_index

the vif index of the interface to become the default multicast interface.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Join a multicast group on an interface.

Parameters:

vif_index	the vif index of the interface to join the multicast group.
group	the multicast group to join.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Leave a multicast group on an interface.

Parameters:

vif_index	the vif index of the interface to leave the multicast group.
group	the multicast group to leave.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Read data from a protocol socket, and then call the appropriate protocol module to process it.

This is called as a SelectorList callback.

Parameters:

fd	file descriptor that with event caused this method to be called.
m	mask representing event type.

Send a packet on a protocol socket.

Parameters:

vif_index	the vif index of the vif that will be used to send-out the packet.
src	the source address of the packet.
dst	the destination address of the packet.
ip_ttl	the TTL (a.k.a. Hop-limit in IPv6) of the packet. If it has a negative value, the TTL will be set here or by the lower layers.
ip_tos	the TOS (a.k.a. Traffic Class in IPv6) of the packet. If it has a negative value, the TOS will be set here or by the lower layers.
router_alert_bool	if true, then the IP packet with the data should have the Router Alert option included.
databuf	the data buffer.
datalen	the length of the data in databuf.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Set/reset the flag whether to ignore the receiving my own packets.

Parameters:

v	if true, ignore my own packets on receiving, otherwise don't ignore them.

[const]

Get the module ID (xorp_module_id) for the protocol that created this entry.

Returns: the module ID (xorp_module_id) of the protocol that created this entry.

Reimplemented from ProtoUnit.