Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
3466 mejdrech 1 
/*
3912 mejdrech 2 
 * Copyright (c) 2009 Lukas Mejdrech
3466 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 
 *  @{
3466 mejdrech 31 
 */
32 
 
33 
/** @file
4350 mejdrech 34 
 *  Generic module functions.
3466 mejdrech 35 
 */
36 
 
4307 mejdrech 37 
#ifndef __NET_MODULES_H__
38 
#define __NET_MODULES_H__
39 
 
3846 mejdrech 40 
#include <async.h>
41 
 
3466 mejdrech 42 
#include <ipc/ipc.h>
43 
#include <ipc/services.h>
44 
 
3846 mejdrech 45 
/** Converts the data length between different types.
4756 mejdrech 46 
 *  @param[in] type_from The source type.
47 
 *  @param[in] type_to The destination type.
48 
 *  @param[in] count The number units of the source type size.
3846 mejdrech 49 
 */
50 
#define CONVERT_SIZE( type_from, type_to, count )   (( sizeof( type_from ) / sizeof( type_to )) * ( count ))
51 
 
4350 mejdrech 52 
/** Registers the module service at the name server.
4756 mejdrech 53 
 *  @param[in] me The module service.
54 
 *  @param[out] phonehash The created phone hash.
4350 mejdrech 55 
 */
3466 mejdrech 56 
#define REGISTER_ME( me, phonehash )    ipc_connect_to_me( PHONE_NS, ( me ), 0, 0, ( phonehash ))
57 
 
4350 mejdrech 58 
/** Connect to the needed module function type definition.
4756 mejdrech 59 
 *  @param[in] need The needed module service.
4350 mejdrech 60 
 *  @returns The phone of the needed service.
61 
 */
4307 mejdrech 62 
typedef int connect_module_t( services_t need );
63 
 
4350 mejdrech 64 
/** Connects to the needed module.
4756 mejdrech 65 
 *  @param[in] need The needed module service.
4350 mejdrech 66 
 *  @returns The phone of the needed service.
67 
 */
68 
int connect_to_service( services_t need );
69 
 
70 
/** Creates bidirectional connection with the needed module service and registers the message receiver.
4756 mejdrech 71 
 *  @param[in] need The needed module service.
72 
 *  @param[in] arg1 The first parameter.
73 
 *  @param[in] arg2 The second parameter.
74 
 *  @param[in] arg3 The third parameter.
75 
 *  @param[in] client_receiver The message receiver.
4350 mejdrech 76 
 *  @returns The phone of the needed service.
77 
 *  @returns Other error codes as defined for the ipc_connect_to_me() function.
78 
 */
3846 mejdrech 79 
int bind_service( services_t need, ipcarg_t arg1, ipcarg_t arg2, ipcarg_t arg3, async_client_conn_t client_receiver );
3466 mejdrech 80 
 
4714 mejdrech 81 
/** Answers the call.
4756 mejdrech 82 
 *  @param[in] callid The call identifier.
83 
 *  @param[in] result The message processing result.
84 
 *  @param[in] answer The message processing answer.
85 
 *  @param[in] answer_count The number of answer parameters.
4714 mejdrech 86 
 */
87 
void    answer_call( ipc_callid_t callid, int result, ipc_call_t * answer, int answer_count );
88 
 
89 
/** Refreshes answer structure and parameters count.
90 
 *  Erases all attributes.
4756 mejdrech 91 
 *  @param[in,out] answer The message processing answer structure.
92 
 *  @param[in,out] answer_count The number of answer parameters.
4714 mejdrech 93 
 */
94 
void    refresh_answer( ipc_call_t * answer, int * answer_count );
95 
 
4722 mejdrech 96 
/** Receives data from the other party.
97 
 *  The received data buffer is allocated and returned.
4756 mejdrech 98 
 *  @param[out] data The data buffer to be filled.
99 
 *  @param[out] length The buffer length.
4722 mejdrech 100 
 *  @returns EOK on success.
101 
 *  @returns EBADMEM if the data or the length parameter is NULL.
102 
 *  @returns EINVAL if the client does not send data.
103 
 *  @returns ENOMEM if there is not enough memory left.
104 
 *  @returns Other error codes as defined for the ipc_data_write_finalize() function.
105 
 */
106 
int data_receive( void ** data, size_t * length );
107 
 
108 
/** Replies the data to the other party.
4756 mejdrech 109 
 *  @param[in] data The data buffer to be sent.
110 
 *  @param[in] data_length The buffer length.
4722 mejdrech 111 
 *  @returns EOK on success.
4731 mejdrech 112 
 *  @returns EINVAL if the client does not expect the data.
113 
 *  @returns EOVERFLOW if the client does not expect all the data. Only partial data are transfered.
4722 mejdrech 114 
 *  @returns Other error codes as defined for the ipc_data_read_finalize() function.
115 
 */
116 
int data_reply( void * data, size_t data_length );
117 
 
4307 mejdrech 118 
#endif
119 
 
3466 mejdrech 120 
/** @}
121 
 */