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


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup net_tl
 *  @{
 */
 
/** @file
 *  Transport layer module interface for the underlying internetwork layer.
 */
 
#ifndef __NET_TL_INTERFACE_H__
#define __NET_TL_INTERFACE_H__
 
#include <async.h>
 
#include <ipc/services.h>
 
#include "../messages.h"
 
#include "../include/device.h"
 
#include "../structures/packet/packet.h"
#include "../structures/packet/packet_client.h"
 
#include "../tl/tl_messages.h"
 
/** @name Transport layer module interface
 *  This interface is used by other modules.
 */
/*@{*/
 
/** Notifies the remote transport layer modules about the received packet/s.
 *  @param tl_phone The transport layer module phone used for remote calls. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param packet The received packet or the received packet queue. The packet queue is used to carry a~fragmented datagram. The first packet contains the headers, the others contain only data. Input parameter.
 *  @param target The target transport layer module service to be delivered to. Input parameter.
 *  @param error The packet error reporting service. Prefixes the received packet. Input parameter.
 *  @returns EOK on success.
 */
inline static int   tl_received_msg( int tl_phone, device_id_t device_id, packet_t packet, services_t target, services_t error ){
    return generic_received_msg( tl_phone, NET_TL_RECEIVED, device_id, packet_get_id( packet ), target, error );
}
 
/*@}*/
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/tl_interface.h @ 4503 – Rev 4707 → 4731

Rev 4707		Rev 4731
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup net_tl	29	/** @addtogroup net_tl
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Transport layer module interface for the underlying internetwork layer.	34	* Transport layer module interface for the underlying internetwork layer.
35	*/	35	*/
36		36
37	#ifndef __NET_TL_INTERFACE_H__	37	#ifndef __NET_TL_INTERFACE_H__
38	#define __NET_TL_INTERFACE_H__	38	#define __NET_TL_INTERFACE_H__
39		39
40	#include <async.h>	40	#include <async.h>
41		41
42	#include <ipc/services.h>	42	#include <ipc/services.h>
43		43
44	#include "../messages.h"	44	#include "../messages.h"
45		45
46	#include "../include/device.h"	46	#include "../include/device.h"
47		47
48	#include "../structures/packet/packet.h"	48	#include "../structures/packet/packet.h"
49	#include "../structures/packet/packet_client.h"	49	#include "../structures/packet/packet_client.h"
50		50
51	#include "../tl/tl_messages.h"	51	#include "../tl/tl_messages.h"
52		52
53	/** @name Transport layer module interface	53	/** @name Transport layer module interface
54	* This interface is used by other modules.	54	* This interface is used by other modules.
55	*/	55	*/
56	/@{/	56	/@{/
57		57
58	/** Notifies the remote transport layer modules about the received packet/s.	58	/** Notifies the remote transport layer modules about the received packet/s.
59	* @param tl_phone The transport layer module phone used for remote calls. Input parameter.	59	* @param tl_phone The transport layer module phone used for remote calls. Input parameter.
60	* @param device_id The device identifier. Input parameter.	60	* @param device_id The device identifier. Input parameter.
61	* @param packet The received packet or the received packet queue. Input parameter.	61	* @param packet The received packet or the received packet queue. The packet queue is used to carry a~fragmented datagram. The first packet contains the headers, the others contain only data. Input parameter.
62	* @param target The target transport layer module service to be delivered to. Input parameter.	62	* @param target The target transport layer module service to be delivered to. Input parameter.
63	* @param error The packet error reporting service. Prefixes the received packet. Input parameter.	63	* @param error The packet error reporting service. Prefixes the received packet. Input parameter.
64	* @returns EOK on success.	64	* @returns EOK on success.
65	*/	65	*/
66	inline static int tl_received_msg( int tl_phone, device_id_t device_id, packet_t packet, services_t target, services_t error ){	66	inline static int tl_received_msg( int tl_phone, device_id_t device_id, packet_t packet, services_t target, services_t error ){
67	return generic_received_msg( tl_phone, NET_TL_RECEIVED, device_id, packet_get_id( packet ), target, error );	67	return generic_received_msg( tl_phone, NET_TL_RECEIVED, device_id, packet_get_id( packet ), target, error );
68	}	68	}
69		69
70	/@}/	70	/@}/
71		71
72	#endif	72	#endif
73		73
74	/** @}	74	/** @}
75	*/	75	*/
76		76