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
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
* 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_transport_h Transport sockets
* @brief The RTR transport sockets implement the communication channel
* (e.g., SSH, TCP, TCP-AO) between an RTR server and client.
* @details Before using the transport socket, a tr_socket must be
* initialized based on a protocol-dependent init function (e.g.,
* tr_tcp_init()).\n
* The tr_* functions call the corresponding function pointers, which are
* passed in the tr_socket struct, and forward the remaining arguments.
*
* @{
*/
#ifndef RTR_TRANSPORT_PRIVATE_H
#define RTR_TRANSPORT_PRIVATE_H
#include "transport.h"
#include <time.h>
/**
* @brief Establish the connection.
* @param[in] socket Socket that will be used.
* @return TR_SUCCESS On success.
* @return TR_ERROR On error.
*/
int tr_open(struct tr_socket *socket);
/**
* @brief Close the socket connection.
* @param[in] socket Socket that will be closed.
*/
void tr_close(struct tr_socket *socket);
/**
* @brief Deallocates all memory that the passed socket uses.
* Socket have to be closed before.
* @param[in] socket which will be freed.
*/
void tr_free(struct tr_socket *socket);
/**
* @brief Receives <= len Bytes data from the socket.
* @param[in] socket Socket that will be used.
* @param[out] buf Received data, must be an allocated memory area of >=pdu_len bytes.
* @param[in] len Size of pdu in Bytes.
* @param[in] timeout Max. seconds the function will block till len data was received.
* @return >0 Number of Bytes read.
* @return TR_ERROR On error.
* @return TR_WOULDBLOCK If no data was available at the socket before the timeout expired.
*/
int tr_recv(const struct tr_socket *socket, void *buf, const size_t len, const time_t timeout);
/**
* @brief Send <= len Bytes data over the socket.
* @param[in] socket Socket that will be used.
* @param[out] pdu Data that will be be sent.
* @param[in] len Size of pdu in Bytes.
* @param[in] timeout Max. seconds the function should try to send the data till it returns.
* @return >0 Number of Bytes sent.
* @return TR_ERROR On error.
*/
int tr_send(const struct tr_socket *socket, const void *pdu, const size_t len, const time_t timeout);
/**
* Repeatedly calls tr_send(..) till len Bytes were sent, the timeout expired or an error occurred.
* @param[in] socket Socket that will be used.
* @param[out] pdu Data that will be be sent.
* @param[in] len Size of pdu in Bytes.
* @param[in] timeout Max. seconds the functions should try to send pdu till it returns.
* @return >0 Number of Bytes sent.
* @return TR_ERROR On Error.
* @return TR_WOULDBLOCK If send would block.
*/
int tr_send_all(const struct tr_socket *socket, const void *pdu, const size_t len, const time_t timeout);
/**
* Repeatedly calls tr_recv(..) till len Bytes were received, the timeout expired or an error occurred.
* @param[in] socket Socket that will be used.
* @param[out] buf Received data, must be an allocated memory area of >=len bytes.
* @param[in] len Size of pdu in Bytes.
* @param[in] timeout Max. seconds the functions should try to receive len data till it returns.
* @return >0 Number of Bytes received.
* @return TR_ERROR On error.
* @return TR_WOULDBLOCK If send would block.
*/
int tr_recv_all(const struct tr_socket *socket, const void *buf, const size_t len, const time_t timeout);
/**
* Returns an identifier for the socket endpoint, eg host:port.
* @param[in] socket
* return Pointer to a \0 terminated String
* return NULL on error
*/
const char *tr_ident(struct tr_socket *socket);
#endif
/** @} */
|
