Subversion Repositories HelenOS

Rev

Rev 4714 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3666 mejdrech 1 
/*
3912 mejdrech 2 
 * Copyright (c) 2009 Lukas Mejdrech
3666 mejdrech 3 
 * All rights reserved.
4 
 *
5 
 * Redistribution and use in source and binary forms, with or without
6 
 * modification, are permitted provided that the following conditions
7 
 * are met:
8 
 *
9 
 * - Redistributions of source code must retain the above copyright
10 
 *   notice, this list of conditions and the following disclaimer.
11 
 * - Redistributions in binary form must reproduce the above copyright
12 
 *   notice, this list of conditions and the following disclaimer in the
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
15 
 *   derived from this software without specific prior written permission.
16 
 *
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
19 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
 */
28 
 
29 
/** @addtogroup net
3912 mejdrech 30 
 *  @{
3666 mejdrech 31 
 */
32 
 
33 
/** @file
4350 mejdrech 34 
 *  Generic module skeleton implementation.
3666 mejdrech 35 
 */
36 
 
37 
#include <async.h>
38 
#include <stdio.h>
39 
#include <task.h>
3846 mejdrech 40 
 
3666 mejdrech 41 
#include <ipc/ipc.h>
42 
 
43 
#include "err.h"
4714 mejdrech 44 
#include "modules.h"
3666 mejdrech 45 
 
4704 mejdrech 46 
/** @name External module functions.
47 
 *  This functions have to be implemented in every module.
48 
 */
49 
/*@{*/
50 
 
4350 mejdrech 51 
/** External message processing function.
52 
 *  Should process the messages.
53 
 *  The function has to be defined in each module.
4756 mejdrech 54 
 *  @param[in] callid The message identifier.
55 
 *  @param[in] call The message parameters.
56 
 *  @param[out] answer The message answer parameters.
57 
 *  @param[out] answer_count The last parameter for the actual answer in the answer parameter.
4350 mejdrech 58 
 *  @returns EOK on success.
59 
 *  @returns ENOTSUP if the message is not known.
60 
 *  @returns Other error codes as defined for each specific module message function.
61 
 */
3846 mejdrech 62 
extern int  module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
4350 mejdrech 63 
 
64 
/** External function to print the module name.
65 
 *  Should print the module name.
66 
 *  The function has to be defined in each module.
67 
 */
3666 mejdrech 68 
extern void module_print_name( void );
4350 mejdrech 69 
 
70 
/** External module startup 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.
4756 mejdrech 73 
 *  @param[in] client_connection The client connection function to be registered.
4350 mejdrech 74 
 */
3846 mejdrech 75 
extern int  module_start( async_client_conn_t client_connection );
3666 mejdrech 76 
 
4704 mejdrech 77 
/*@}*/
78 
 
4350 mejdrech 79 
/** Default thread for new connections.
4756 mejdrech 80 
 *  @param[in] iid The initial message identifier.
81 
 *  @param[in] icall The initial message call structure.
4350 mejdrech 82 
 */
3846 mejdrech 83 
void    client_connection( ipc_callid_t iid, ipc_call_t * icall );
4350 mejdrech 84 
 
85 
/** Starts the module.
86 
 *  @param argc The count of the command line arguments. Ignored parameter.
87 
 *  @param argv The command line parameters. Ignored parameter.
88 
 *  @returns EOK on success.
89 
 *  @returns Other error codes as defined for each specific module start function.
90 
 */
3846 mejdrech 91 
int main( int argc, char * argv[] );
3666 mejdrech 92 
 
93 
void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
3846 mejdrech 94 
    ipc_callid_t    callid;
4714 mejdrech 95 
    ipc_call_t      call;
96 
    ipc_call_t      answer;
97 
    int             answer_count;
98 
    int             res;
3666 mejdrech 99 
 
3846 mejdrech 100 
    /*
101 
     * Accept the connection
102 
     *  - Answer the first IPC_M_CONNECT_ME_TO call.
103 
     */
3666 mejdrech 104 
    ipc_answer_0( iid, EOK );
105 
 
106 
    while( true ){
4714 mejdrech 107 
        refresh_answer( & answer, & answer_count );
3846 mejdrech 108 
 
3666 mejdrech 109 
        callid = async_get_call( & call );
4714 mejdrech 110 
        res = module_message( callid, & call, & answer, & answer_count );
3846 mejdrech 111 
 
4714 mejdrech 112 
        answer_call( callid, res, & answer, answer_count );
3666 mejdrech 113 
    }
114 
}
115 
 
116 
int main( int argc, char * argv[] ){
117 
    ERROR_DECLARE;
118 
 
4307 mejdrech 119 
    printf("Task %d - ", task_get_id());
3666 mejdrech 120 
    module_print_name();
4307 mejdrech 121 
    printf( "\n" );
3912 mejdrech 122 
    if( ERROR_OCCURRED( module_start( client_connection ))){
4307 mejdrech 123 
        printf( " - ERROR %i\n", ERROR_CODE );
3666 mejdrech 124 
        return ERROR_CODE;
125 
    }
126 
    return EOK;
127 
}
128 
 
129 
/** @}
130 
 */