WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/include/ip_interface.h



/** @addtogroup ip
 *  @{
 */
 
/** @file
 *  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.
 */
 

 
#include "../structures/packet/packet.h"
 
#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.
 *  @param packet The received packet or the received packet queue. Input parameter.
 *  @param receiver The receiving module service. Input parameter.
 *  @returns EOK on success.
 */
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 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.
 *  @param tl_received_msg The message processing function. Used if bundled together. Input parameter.
 *  @returns The phone of the needed service.

 *  @returns Other error codes as defined for the arp_device_req() function.
 */
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
 
/** Sends the packet queue.
 *  @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.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the generic_send_msg() function.

 */
int ip_connect_module( services_t service );
 
/** Adds a route to the device routing table.
 *  The target network is routed using this device.
 *  @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.
 *  @param gateway The target network gateway. Not used if zero. Input parameter.
 */
int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );
 
/** Sets the default gateway.
 *  This gateway is used if no other route is found.
 *  @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.
 */
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 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.
 *  @param content The maximum content size. Output parameter.
 *  @param suffix The minimum reserved suffix size. Output parameter.

 *  @returns ENOENT if there is no such device.
 *  @returns Other error codes as defined for the generic_packet_size_req() function.
 */
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
 
/** @}
 */

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/ip_interface.h – Rev 4693 → 4704

Rev 4693		Rev 4704
Line 29...		Line 29...
29	/** @addtogroup ip	29	/** @addtogroup ip
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Internet protocol interface.	34	* IP module interface.
35	* The same interface is used for standalone remote modules as well as for bundle modules.	35	* The same interface is used for standalone remote modules as well as for bundle modules.
36	* The standalone remote modules have to be compiled with the ip_remote.c source file.	36	* The standalone remote modules have to be compiled with the ip_remote.c source file.
37	* The bundle modules with the ip.c source file.	37	* The bundle modules with the ip.c source file.
38	*/	38	*/
39		39
Line 48...		Line 48...
48		48
49	#include "../structures/packet/packet.h"	49	#include "../structures/packet/packet.h"
50		50
51	#include "in.h"	51	#include "in.h"
52		52
-		53	/** @name IP module interface
-		54	* This interface is used by other modules.
-		55	*/
-		56	/@{/
-		57
53	/** The transport layer notification function type definition.	58	/** The transport layer notification function type definition.
54	* Notifies the transport layer modules about the received packet/s.	59	* Notifies the transport layer modules about the received packet/s.
55	* @param device_id The device identifier. Input parameter.	60	* @param device_id The device identifier. Input parameter.
56	* @param packet The received packet or the received packet queue. Input parameter.	61	* @param packet The received packet or the received packet queue. Input parameter.
57	* @param receiver The receiving module service. Input parameter.	62	* @param receiver The receiving module service. Input parameter.
58	* @returns EOK on success.	63	* @returns EOK on success.
59	*/	64	*/
60	typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );	65	typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );
61		66
62	/** Creates bidirectional connection with the ip module service and registers the message receiver.	67	/** Creates bidirectional connection with the ip module service and registers the message receiver.
63	* @param service The ip module service. Input parameter.	68	* @param service The IP module service. Input parameter.
64	* @param protocol The transport layer protocol. Input parameter.	69	* @param protocol The transport layer protocol. Input parameter.
65	* @param me The requesting module service. Input parameter.	70	* @param me The requesting module service. Input parameter.
66	* @param receiver The message receiver. Used for remote connection. Input parameter.	71	* @param receiver The message receiver. Used for remote connection. Input parameter.
67	* @param tl_received_msg The message processing function. Used if bundled together. Input parameter.	72	* @param tl_received_msg The message processing function. Used if bundled together. Input parameter.
68	* @returns The phone of the needed service.	73	* @returns The phone of the needed service.
Line 86...		Line 91...
86	* @returns Other error codes as defined for the arp_device_req() function.	91	* @returns Other error codes as defined for the arp_device_req() function.
87	*/	92	*/
88	int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );	93	int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
89		94
90	/** Sends the packet queue.	95	/** Sends the packet queue.
91	* @param ip_phone The internet protocol phone. Input parameter.	96	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
92	* @param device_id The device identifier. Input parameter.	97	* @param device_id The device identifier. Input parameter.
93	* @param packet The packet queue. Input parameter.	98	* @param packet The packet queue. Input parameter.
94	* @param sender The sending module service. Input parameter.	99	* @param sender The sending module service. Input parameter.
95	* @returns EOK on success.	100	* @returns EOK on success.
96	* @returns Other error codes as defined for the generic_send_msg() function.	101	* @returns Other error codes as defined for the generic_send_msg() function.
Line 104...		Line 109...
104	*/	109	*/
105	int ip_connect_module( services_t service );	110	int ip_connect_module( services_t service );
106		111
107	/** Adds a route to the device routing table.	112	/** Adds a route to the device routing table.
108	* The target network is routed using this device.	113	* The target network is routed using this device.
109	* @param ip_phone The internet protocol phone. Input parameter.	114	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
110	* @param device_id The device identifier. Input parameter.	115	* @param device_id The device identifier. Input parameter.
111	* @param address The target network address. Input parameter.	116	* @param address The target network address. Input parameter.
112	* @param netmask The target network mask. Input parameter.	117	* @param netmask The target network mask. Input parameter.
113	* @param gateway The target network gateway. Not used if zero. Input parameter.	118	* @param gateway The target network gateway. Not used if zero. Input parameter.
114	*/	119	*/
115	int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );	120	int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );
116		121
117	/** Sets the default gateway.	122	/** Sets the default gateway.
118	* This gateway is used if no other route is found.	123	* This gateway is used if no other route is found.
119	* @param ip_phone The internet protocol phone. Input parameter.	124	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
120	* @param device_id The device identifier. Input parameter.	125	* @param device_id The device identifier. Input parameter.
121	* @param gateway The default gateway. Input parameter.	126	* @param gateway The default gateway. Input parameter.
122	*/	127	*/
123	int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );	128	int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );
124		129
125	/** Returns the device packet dimensions for sending.	130	/** Returns the device packet dimensions for sending.
126	* @param ip_phone The internet protocol phone. Input parameter.	131	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
127	* @param device_id The device identifier. Input parameter.	132	* @param device_id The device identifier. Input parameter.
128	* @param addr_len The minimum reserved address length. Output parameter.	133	* @param addr_len The minimum reserved address length. Output parameter.
129	* @param prefix The minimum reserved prefix size. Output parameter.	134	* @param prefix The minimum reserved prefix size. Output parameter.
130	* @param content The maximum content size. Output parameter.	135	* @param content The maximum content size. Output parameter.
131	* @param suffix The minimum reserved suffix size. Output parameter.	136	* @param suffix The minimum reserved suffix size. Output parameter.
Line 134...		Line 139...
134	* @returns ENOENT if there is no such device.	139	* @returns ENOENT if there is no such device.
135	* @returns Other error codes as defined for the generic_packet_size_req() function.	140	* @returns Other error codes as defined for the generic_packet_size_req() function.
136	*/	141	*/
137	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 );	142	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 );
138		143
-		144	/@}/
-		145
139	#endif	146	#endif
140		147
141	/** @}	148	/** @}
142	*/	149	*/