blob: 3198050657bc3857201bbe5bbe05d7840a0cb8f2 (
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
|
/*
* This file is part of RTRlib.
*
* This file is subject to the terms and conditions of the MIT license.
* See the file LICENSE in the top level directory for more details.
*
* Website: http://rtrlib.realmv6.org/
*/
/**
* @defgroup mod_tcp_transport_h TCP transport socket
* @ingroup mod_transport_h
* @brief An implementation of the TCP protocol for the RTR transport.
* See @ref mod_transport_h "transport interface" for a list of supported operations.
*
* @{
*/
#ifndef RTR_TCP_TRANSPORT_H
#define RTR_TCP_TRANSPORT_H
#include "rtrlib/transport/transport.h"
/**
* @brief A tr_tcp_config struct holds configuration for a TCP connection.
* @param host Hostname or IP address to connect to.
* @param port Port to connect to.
* @param bindaddr Hostname or IP address to connect from. NULL for
* determination by OS.
* to use the source address of the system's default route to the server
* @param data Information to pass to callback function
* in charge of retrieving socket
* @param new_socket(void *opaque_info) callback routine, that
* Pointer to the function that is called every time a new connection
* is made. The returned socket is expected to be ready for use (e.g.
* in state established), and must use a reliably stream-oriented transport.
* When new_socket() is used, host, port, and bindaddr are not used.
* @param connect_timeout Time in seconds to wait for a successful connection.
* Defaults to #RTRLIB_TRANSPORT_CONNECT_TIMEOUT_DEFAULT
*/
struct tr_tcp_config {
char *host;
char *port;
char *bindaddr;
void *data;
int (*new_socket)(void *data);
unsigned int connect_timeout;
};
/**
* @brief Initializes the tr_socket struct for a TCP connection.
* @param[in] config TCP configuration for the connection.
* @param[out] socket Initialized transport socket.
* @returns TR_SUCCESS On success.
* @returns TR_ERROR On error.
*/
int tr_tcp_init(const struct tr_tcp_config *config, struct tr_socket *socket);
#endif
/** @} */
|
