| 63,20 → 63,20 |
|---|
| |
| /** 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. |
| * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
| * @param[in] device_id The device identifier. |
| * @param[in] packet The received packet or the received packet queue. |
| * @param[in] receiver The receiving module service. |
| * @param[in] error The packet error reporting service. Prefixes the received packet. |
| * @returns EOK on success. |
| */ |
| typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver, services_t error ); |
| |
| /** 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. |
| * @param[in] service The IP module service. |
| * @param[in] protocol The transport layer protocol. |
| * @param[in] me The requesting module service. |
| * @param[in] receiver The message receiver. Used for remote connection. |
| * @param[in] tl_received_msg The message processing function. Used if bundled together. |
| * @returns The phone of the needed service. |
| * @returns EOK on success. |
| * @returns Other error codes as defined for the bind_service() function. |
| 86,9 → 86,9 |
|---|
| /** Registers the new device. |
| * Registers itself as the ip packet receiver. |
| * If the device uses ARP registers also the new ARP device. |
| * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
| * @param device_id The new device identifier. Input parameter. |
| * @param netif The underlying device network interface layer service. Input parameter. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] device_id The new device identifier. |
| * @param[in] netif The underlying device network interface layer service. |
| * @returns EOK on success. |
| * @returns ENOMEM if there is not enough memory left. |
| * @returns EINVAL if the device configuration is invalid. |
| 101,11 → 101,11 |
|---|
| |
| /** Sends the packet queue. |
| * The packets may get fragmented if needed. |
| * @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 fragments as a~packet queue. All the packets have to have the same destination address. Input parameter. |
| * @param sender The sending module service. Input parameter. |
| * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] device_id The device identifier. |
| * @param[in] packet The packet fragments as a~packet queue. All the packets have to have the same destination address. |
| * @param[in] sender The sending module service. |
| * @param[in] error The packet error reporting service. Prefixes the received packet. |
| * @returns EOK on success. |
| * @returns Other error codes as defined for the generic_send_msg() function. |
| */ |
| 120,29 → 120,29 |
|---|
| |
| /** 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. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] device_id The device identifier. |
| * @param[in] address The target network address. |
| * @param[in] netmask The target network mask. |
| * @param[in] gateway The target network gateway. Not used if zero. |
| */ |
| 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. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] device_id The device identifier. |
| * @param[in] gateway The default gateway. |
| */ |
| 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. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] device_id The device identifier. |
| * @param[out] addr_len The minimum reserved address length. |
| * @param[out] prefix The minimum reserved prefix size. |
| * @param[out] content The maximum content size. |
| * @param[out] suffix The minimum reserved suffix size. |
| * @returns EOK on success. |
| * @returns EBADMEM if either one of the parameters is NULL. |
| * @returns ENOENT if there is no such device. |
| 151,16 → 151,23 |
|---|
| 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 ); |
| |
| /** Notifies the IP module about the received error notification packet. |
| * @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 received packet or the received packet queue. Input parameter. |
| * @param target The target internetwork module service to be delivered to. Input parameter. |
| * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] device_id The device identifier. |
| * @param[in] packet The received packet or the received packet queue. |
| * @param[in] target The target internetwork module service to be delivered to. |
| * @param[in] error The packet error reporting service. Prefixes the received packet. |
| * @returns EOK on success. |
| */ |
| int ip_received_error_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t target, services_t error ); |
| |
| /** \todo |
| /** Returns the device identifier and the IP pseudo header based on the destination address. |
| * @param[in] ip_phone The IP module phone used for (semi)remote calls. |
| * @param[in] protocol The transport protocol. |
| * @param[in] destination The destination address. |
| * @param[in] addrlen The destination address length. |
| * @param[out] device_id The device identifier. |
| * @param[out] header The constructed IP pseudo header. |
| * @param[out] headerlen The IP pseudo header length. |
| */ |
| int ip_get_route_req( int ip_phone, ip_protocol_t protocol, const struct sockaddr * destination, socklen_t addrlen, device_id_t * device_id, ip_pseudo_header_ref * header, size_t * headerlen ); |
| |