31,7 → 31,7 |
*/ |
|
/** @file |
* Internet protocol interface. |
* IP module interface. |
* The same interface is used for standalone remote modules as well as for bundle modules. |
* The standalone remote modules have to be compiled with the ip_remote.c source file. |
* The bundle modules with the ip.c source file. |
50,6 → 50,11 |
|
#include "in.h" |
|
/** @name IP module interface |
* This interface is used by other modules. |
*/ |
/*@{*/ |
|
/** The transport layer notification function type definition. |
* Notifies the transport layer modules about the received packet/s. |
* @param device_id The device identifier. Input parameter. |
60,7 → 65,7 |
typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver ); |
|
/** Creates bidirectional connection with the ip module service and registers the message receiver. |
* @param service The ip module service. Input parameter. |
* @param service The IP module service. Input parameter. |
* @param protocol The transport layer protocol. Input parameter. |
* @param me The requesting module service. Input parameter. |
* @param receiver The message receiver. Used for remote connection. Input parameter. |
88,7 → 93,7 |
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif ); |
|
/** Sends the packet queue. |
* @param ip_phone The internet protocol phone. Input parameter. |
* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param packet The packet queue. Input parameter. |
* @param sender The sending module service. Input parameter. |
106,7 → 111,7 |
|
/** Adds a route to the device routing table. |
* The target network is routed using this device. |
* @param ip_phone The internet protocol phone. Input parameter. |
* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param address The target network address. Input parameter. |
* @param netmask The target network mask. Input parameter. |
116,7 → 121,7 |
|
/** Sets the default gateway. |
* This gateway is used if no other route is found. |
* @param ip_phone The internet protocol phone. Input parameter. |
* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param gateway The default gateway. Input parameter. |
*/ |
123,7 → 128,7 |
int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway ); |
|
/** Returns the device packet dimensions for sending. |
* @param ip_phone The internet protocol phone. Input parameter. |
* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param addr_len The minimum reserved address length. Output parameter. |
* @param prefix The minimum reserved prefix size. Output parameter. |
136,6 → 141,8 |
*/ |
int ip_packet_size_req( int ip_phone, device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix ); |
|
/*@}*/ |
|
#endif |
|
/** @} |