WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/module.c


/*
 * 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
 *  @{
 */
 
/** @file
 *  Generic module skeleton implementation.
 */
 
#include <async.h>
#include <stdio.h>
#include <task.h>
 
#include <ipc/ipc.h>
 
#include "err.h"
#include "modules.h"
 
/** @name External module functions.
 *  This functions have to be implemented in every module.
 */
/*@{*/
 
/** External message processing function.
 *  Should process the messages.
 *  The function has to be defined in each module.
 *  @param[in] callid The message identifier.
 *  @param[in] call The message parameters.
 *  @param[out] answer The message answer parameters.
 *  @param[out] answer_count The last parameter for the actual answer in the answer parameter.
 *  @returns EOK on success.
 *  @returns ENOTSUP if the message is not known.
 *  @returns Other error codes as defined for each specific module message function.
 */
extern int  module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** External function to print the module name.
 *  Should print the module name.
 *  The function has to be defined in each module.
 */
extern void module_print_name( void );
 
/** External module startup function.
 *  Should start and initialize the module and register the given client connection function.
 *  The function has to be defined in each module.
 *  @param[in] client_connection The client connection function to be registered.
 */
extern int  module_start( async_client_conn_t client_connection );
 
/*@}*/
 
/** Default thread for new connections.
 *  @param[in] iid The initial message identifier.
 *  @param[in] icall The initial message call structure.
 */
void    client_connection( ipc_callid_t iid, ipc_call_t * icall );
 
/** Starts the module.
 *  @param argc The count of the command line arguments. Ignored parameter.
 *  @param argv The command line parameters. Ignored parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for each specific module start function.
 */
int main( int argc, char * argv[] );
 
void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
    ipc_callid_t    callid;
    ipc_call_t      call;
    ipc_call_t      answer;
    int             answer_count;
    int             res;
 
    /*
     * Accept the connection
     *  - Answer the first IPC_M_CONNECT_ME_TO call.
     */
    ipc_answer_0( iid, EOK );
 
    while( true ){
        refresh_answer( & answer, & answer_count );
 
        callid = async_get_call( & call );
        res = module_message( callid, & call, & answer, & answer_count );
 
        answer_call( callid, res, & answer, answer_count );
    }
}
 
int main( int argc, char * argv[] ){
    ERROR_DECLARE;
 
    printf("Task %d - ", task_get_id());
    module_print_name();
    printf( "\n" );
    if( ERROR_OCCURRED( module_start( client_connection ))){
        printf( " - ERROR %i\n", ERROR_CODE );
        return ERROR_CODE;
    }
    return EOK;
}
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/module.c – Rev 4714 → 4756

Rev 4714		Rev 4756
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	29	/** @addtogroup net
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Generic module skeleton implementation.	34	* Generic module skeleton implementation.
35	*/	35	*/
36		36
37	#include <async.h>	37	#include <async.h>
38	#include <stdio.h>	38	#include <stdio.h>
39	#include <task.h>	39	#include <task.h>
40		40
41	#include <ipc/ipc.h>	41	#include <ipc/ipc.h>
42		42
43	#include "err.h"	43	#include "err.h"
44	#include "modules.h"	44	#include "modules.h"
45		45
46	/** @name External module functions.	46	/** @name External module functions.
47	* This functions have to be implemented in every module.	47	* This functions have to be implemented in every module.
48	*/	48	*/
49	/@{/	49	/@{/
50		50
51	/** External message processing function.	51	/** External message processing function.
52	* Should process the messages.	52	* Should process the messages.
53	* The function has to be defined in each module.	53	* The function has to be defined in each module.
54	* @param callid The message identifier. Input parameter.	54	* @param[in] callid The message identifier.
55	* @param call The message parameters. Input parameter.	55	* @param[in] call The message parameters.
56	* @param answer The message answer parameters. Output parameter.	56	* @param[out] answer The message answer parameters.
57	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.	57	* @param[out] answer_count The last parameter for the actual answer in the answer parameter.
58	* @returns EOK on success.	58	* @returns EOK on success.
59	* @returns ENOTSUP if the message is not known.	59	* @returns ENOTSUP if the message is not known.
60	* @returns Other error codes as defined for each specific module message function.	60	* @returns Other error codes as defined for each specific module message function.
61	*/	61	*/
62	extern int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );	62	extern int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
63		63
64	/** External function to print the module name.	64	/** External function to print the module name.
65	* Should print the module name.	65	* Should print the module name.
66	* The function has to be defined in each module.	66	* The function has to be defined in each module.
67	*/	67	*/
68	extern void module_print_name( void );	68	extern void module_print_name( void );
69		69
70	/** External module startup function.	70	/** External module startup function.
71	* Should start and initialize the module and register the given client connection function.	71	* Should start and initialize the module and register the given client connection function.
72	* The function has to be defined in each module.	72	* The function has to be defined in each module.
73	* @param client_connection The client connection function to be registered. Input parameter.	73	* @param[in] client_connection The client connection function to be registered.
74	*/	74	*/
75	extern int module_start( async_client_conn_t client_connection );	75	extern int module_start( async_client_conn_t client_connection );
76		76
77	/@}/	77	/@}/
78		78
79	/** Default thread for new connections.	79	/** Default thread for new connections.
80	* @param iid The initial message identifier. Input parameter.	80	* @param[in] iid The initial message identifier.
81	* @param icall The initial message call structure. Input parameter.	81	* @param[in] icall The initial message call structure.
82	*/	82	*/
83	void client_connection( ipc_callid_t iid, ipc_call_t * icall );	83	void client_connection( ipc_callid_t iid, ipc_call_t * icall );
84		84
85	/** Starts the module.	85	/** Starts the module.
86	* @param argc The count of the command line arguments. Ignored parameter.	86	* @param argc The count of the command line arguments. Ignored parameter.
87	* @param argv The command line parameters. Ignored parameter.	87	* @param argv The command line parameters. Ignored parameter.
88	* @returns EOK on success.	88	* @returns EOK on success.
89	* @returns Other error codes as defined for each specific module start function.	89	* @returns Other error codes as defined for each specific module start function.
90	*/	90	*/
91	int main( int argc, char * argv[] );	91	int main( int argc, char * argv[] );
92		92
93	void client_connection( ipc_callid_t iid, ipc_call_t * icall ){	93	void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
94	ipc_callid_t callid;	94	ipc_callid_t callid;
95	ipc_call_t call;	95	ipc_call_t call;
96	ipc_call_t answer;	96	ipc_call_t answer;
97	int answer_count;	97	int answer_count;
98	int res;	98	int res;
99		99
100	/*	100	/*
101	* Accept the connection	101	* Accept the connection
102	* - Answer the first IPC_M_CONNECT_ME_TO call.	102	* - Answer the first IPC_M_CONNECT_ME_TO call.
103	*/	103	*/
104	ipc_answer_0( iid, EOK );	104	ipc_answer_0( iid, EOK );
105		105
106	while( true ){	106	while( true ){
107	refresh_answer( & answer, & answer_count );	107	refresh_answer( & answer, & answer_count );
108		108
109	callid = async_get_call( & call );	109	callid = async_get_call( & call );
110	res = module_message( callid, & call, & answer, & answer_count );	110	res = module_message( callid, & call, & answer, & answer_count );
111		111
112	answer_call( callid, res, & answer, answer_count );	112	answer_call( callid, res, & answer, answer_count );
113	}	113	}
114	}	114	}
115		115
116	int main( int argc, char * argv[] ){	116	int main( int argc, char * argv[] ){
117	ERROR_DECLARE;	117	ERROR_DECLARE;
118		118
119	printf("Task %d - ", task_get_id());	119	printf("Task %d - ", task_get_id());
120	module_print_name();	120	module_print_name();
121	printf( "\n" );	121	printf( "\n" );
122	if( ERROR_OCCURRED( module_start( client_connection ))){	122	if( ERROR_OCCURRED( module_start( client_connection ))){
123	printf( " - ERROR %i\n", ERROR_CODE );	123	printf( " - ERROR %i\n", ERROR_CODE );
124	return ERROR_CODE;	124	return ERROR_CODE;
125	}	125	}
126	return EOK;	126	return EOK;
127	}	127	}
128		128
129	/** @}	129	/** @}
130	*/	130	*/
131		131