NETIO_DGRAM_InterfaceI Struct Reference

<<eXtension>> <<cert>> . More...

#include <netio_dgram.h>

Data Fields
NETIO_DGRAM_Interface_createFunc	create_instance
	Creates an instance of the user defined datagram Interface.
NETIO_DGRAMUserInterface_deleteFunc	delete_instance
	Deletes an instance of the user defined datagram Interface. Not in CERT.
NETIO_DGRAMUserInterface_get_interface_listFunc	get_interface_list
	Read available interfaces from the user DGRAM Interface.
NETIO_Interface_release_addressFunc	release_address
	Release addresses to the DGRAMInterfaceUser.
NETIO_DGRAMUserInterface_resolve_addressFunc	resolve_address
	Resolve an address string from DGRAM user interface.
NETIO_Interface_sendFunc	send
	Send a message with the DGRAM user interface.
NETIO_Interface_get_route_tableFunc	get_route_table
	Read the route table from the DGRAM user interface.
NETIO_DGRAMUserInterface_bind_addressFunc	bind_address
	Bind to an address.

---

Detailed Description

<<eXtension>> <<cert>> .

---

Field Documentation

NETIO_DGRAM_Interface_createFunc NETIO_DGRAM_InterfaceI::create_instance

Creates an instance of the user defined datagram Interface.

A user defined datagram function that is called by RTI Connext DDS Micro to create an instance of the NETIO_DGRAM transport.

Parameters:

[in]	upstream	The upstream interface.
[in]	property	The user defined interface property.

Returns:

The function must return a pointer to a new instance on success and NULL on failure.

NETIO_DGRAMUserInterface_deleteFunc NETIO_DGRAM_InterfaceI::delete_instance

Deletes an instance of the user defined datagram Interface. Not in CERT.

A user defined datagram function that is called by RTI Connext DDS Micro to create an instance of the NETIO_DGRAM transport.

Parameters:

[in]

upstream

The upstream interface.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

NETIO_DGRAMUserInterface_get_interface_listFunc NETIO_DGRAM_InterfaceI::get_interface_list

Read available interfaces from the user DGRAM Interface.

A user defined datagram function that is called by RTI Connext DDS Micro to read the available interfaces from a transport.

Parameters:

[in]	netio_intf	The DGRAM interface to use.
[in]	if_table	The interface table.

Returns:

TRUE on success, FALSE on failure.

NETIO_Interface_release_addressFunc NETIO_DGRAM_InterfaceI::release_address

Release addresses to the DGRAMInterfaceUser.

A user defined datagram function that is called by RTI Connext DDS Micro when an address is no longer in use.

Parameters:

[in]	self	The DGRAM interface to use.
[in]	src_addr	The address to release.

Returns:

TRUE on success, FALSE on failure.

NETIO_DGRAMUserInterface_resolve_addressFunc NETIO_DGRAM_InterfaceI::resolve_address

Resolve an address string from DGRAM user interface.

A user defined datagram function that is called by RTI Connext DDS Micro to convert an address in string format to a numerical value. The if_entry multicast_group decides if the address is a multicast group. The address_value is automatically marked as a multicast address if the resolve_address function returns RTI_TRUE.

If resolve_address is NULL when calling NETIO_DGRAM_InterfaceFactory_register, RTI Connext DDS Micro will resolve addresses in the dotted IPv4 notation "a.b.c.d" where a, b, c, and d are decimal integers between 0-255.

Parameters:

[in]	netio_intf	Interface.
[in]	if_entry	The interface entry requested to resolve the address.
[in]	address_string	Address to convert.
[out]	address_value	Converted address.
[out]	is_invalid	If the address is valid or not.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

NETIO_Interface_sendFunc NETIO_DGRAM_InterfaceI::send

Send a message with the DGRAM user interface.

A user defined datagram function that is called by RTI Connext DDS Micro to forward a packet from a source interface to a destination with the user defined DGRAM interface.

Parameters:

[in]	self	DGRAM interface to send from.
[in]	source	The source interface for the packet.
[in]	destination	The destination address for the packet.
[in]	packet	The packet to send.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

NETIO_Interface_get_route_tableFunc NETIO_DGRAM_InterfaceI::get_route_table

Read the route table from the DGRAM user interface.

A user defined datagram function that will be used by RTI Connext DDS Micro to get the route table from the DGRAM interface. The route table is a sequence of address and netmask pairs that informs RTI Connext DDS Micro which locators can be reached from the transport.

Parameters:

[in]	netio_intf	The NETIO interface.
[in,out]	address	Sequence of NETIO addresses this interface understands.
[in,out]	netmask	Sequence of the corresponding netmasks.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

NETIO_DGRAMUserInterface_bind_addressFunc NETIO_DGRAM_InterfaceI::bind_address

Bind to an address.

A user defined datagram function called by RTI Connext DDS Micro to staring listening on the specified address.

Parameters:

[in]	user_intf	DGRAM interface to to use.
[in]	source	The address to bind.

Returns:

RTI_TRUE if successful, RTI_FALSE if not.