blob: cde7859c2daab2155931a9a69181d787928de5b2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* Copyright (C) 2010-2013 Tobias Brunner
* Hochschule fuer Technik Rapperswil
* Copyright (C) 2010 Martin Willi
* Copyright (C) 2010 revosec AG
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup socket_manager socket_manager
* @{ @ingroup network
*/
#ifndef SOCKET_MANAGER_H_
#define SOCKET_MANAGER_H_
#include <network/socket.h>
typedef struct socket_manager_t socket_manager_t;
/**
* Handle pluggable socket implementations and send/receive packets through it.
*/
struct socket_manager_t {
/**
* Receive a packet using the registered socket.
*
* @param packet allocated packet that has been received
* @return
* - SUCCESS when packet successfully received
* - FAILED when unable to receive
*/
status_t (*receive)(socket_manager_t *this, packet_t **packet);
/**
* Send a packet using the registered socket.
*
* @param packet packet to send out
* @return
* - SUCCESS when packet successfully sent
* - FAILED when unable to send
*/
status_t (*send)(socket_manager_t *this, packet_t *packet);
/**
* Get the port the registered socket is listening on.
*
* @param nat_t TRUE to get the port used to float in case of NAT-T
* @return the port, or 0, if no socket is registered
*/
uint16_t (*get_port)(socket_manager_t *this, bool nat_t);
/**
* Get the address families the registered socket is listening on.
*
* @return address families
*/
socket_family_t (*supported_families)(socket_manager_t *this);
/**
* Register a socket constructor.
*
* @param create constructor for the socket
*/
void (*add_socket)(socket_manager_t *this, socket_constructor_t create);
/**
* Unregister a registered socket constructor.
*
* @param create constructor for the socket
*/
void (*remove_socket)(socket_manager_t *this, socket_constructor_t create);
/**
* Destroy a socket_manager_t.
*/
void (*destroy)(socket_manager_t *this);
};
/**
* Create a socket_manager instance.
*/
socket_manager_t *socket_manager_create();
#endif /** SOCKET_MANAGER_H_ @}*/
|
