| 1 | /*
|
|---|
| 2 | * Copyright (c) 2010 Martin Decky
|
|---|
| 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 libnet
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | #ifndef LIBNET_TL_SKEL_H_
|
|---|
| 34 | #define LIBNET_TL_SKEL_H_
|
|---|
| 35 |
|
|---|
| 36 | /** @file
|
|---|
| 37 | * Transport layer module skeleton.
|
|---|
| 38 | * The skeleton has to be part of each transport layer module.
|
|---|
| 39 | */
|
|---|
| 40 |
|
|---|
| 41 | #include <async.h>
|
|---|
| 42 | #include <fibril_synch.h>
|
|---|
| 43 | #include <ipc/ipc.h>
|
|---|
| 44 | #include <ipc/services.h>
|
|---|
| 45 |
|
|---|
| 46 | #include <adt/measured_strings.h>
|
|---|
| 47 | #include <net/device.h>
|
|---|
| 48 | #include <net/packet.h>
|
|---|
| 49 |
|
|---|
| 50 | /** Module initialization.
|
|---|
| 51 | *
|
|---|
| 52 | * This has to be implemented in user code.
|
|---|
| 53 | *
|
|---|
| 54 | * @param[in] net_phone Networking module phone.
|
|---|
| 55 | *
|
|---|
| 56 | * @return EOK on success.
|
|---|
| 57 | * @return Other error codes as defined for each specific module
|
|---|
| 58 | * initialize function.
|
|---|
| 59 | *
|
|---|
| 60 | */
|
|---|
| 61 | extern int tl_initialize(int net_phone);
|
|---|
| 62 |
|
|---|
| 63 | /** Per-connection module initialization.
|
|---|
| 64 | *
|
|---|
| 65 | * This has to be implemented in user code.
|
|---|
| 66 | *
|
|---|
| 67 | */
|
|---|
| 68 | extern void tl_connection(void);
|
|---|
| 69 |
|
|---|
| 70 | /** Process the transport layer module message.
|
|---|
| 71 | *
|
|---|
| 72 | * This has to be implemented in user code.
|
|---|
| 73 | *
|
|---|
| 74 | * @param[in] callid Message identifier.
|
|---|
| 75 | * @param[in] call Message parameters.
|
|---|
| 76 | * @param[out] answer Answer.
|
|---|
| 77 | * @param[out] count Number of arguments of the answer.
|
|---|
| 78 | *
|
|---|
| 79 | * @return EOK on success.
|
|---|
| 80 | * @return Other error codes as defined for each specific module.
|
|---|
| 81 | *
|
|---|
| 82 | */
|
|---|
| 83 | extern int tl_message(ipc_callid_t, ipc_call_t *,
|
|---|
| 84 | ipc_call_t *, size_t *);
|
|---|
| 85 |
|
|---|
| 86 | extern int tl_module_start(int);
|
|---|
| 87 |
|
|---|
| 88 | #endif
|
|---|
| 89 |
|
|---|
| 90 | /** @}
|
|---|
| 91 | */
|
|---|
