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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
//
// Copyright 2016 Garrett D'Amore <garrett@damore.org>
//
// This software is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
#ifndef CORE_TRANSPORT_H
#define CORE_TRANSPORT_H
// Transport implementation details. Transports must implement the
// interfaces in this file.
struct nni_tran {
// tran_scheme is the transport scheme, such as "tcp" or "inproc".
const char * tran_scheme;
// tran_ep links our endpoint-specific operations.
const nni_tran_ep * tran_ep;
// tran_pipe links our pipe-specific operations.
const nni_tran_pipe * tran_pipe;
// tran_init, if not NULL, is called once during library
// initialization.
int (*tran_init)(void);
// tran_fini, if not NULL, is called during library deinitialization.
// It should release any global resources, close any open files, etc.
void (*tran_fini)(void);
};
// Endpoint operations are called by the socket in a protocol-independent
// fashion. The socket makes individual calls, which are expected to block
// if appropriate (except for destroy). Endpoints are unable to call back
// into the socket, to prevent recusive entry and deadlock.
struct nni_tran_ep {
// ep_init creates a vanilla endpoint. The value created is
// used for the first argument for all other endpoint functions.
int (*ep_init)(void **, const char *, nni_sock *);
// ep_fini frees the resources associated with the endpoint.
// The endpoint will already have been closed.
void (*ep_fini)(void *);
// ep_connect establishes a connection, and creates a new pipe,
// which is returned in the final argument. It can return errors
// NNG_EACCESS, NNG_ECONNREFUSED, NNG_EBADADDR, NNG_ECONNFAILED,
// NNG_ETIMEDOUT, and NNG_EPROTO.
int (*ep_connect)(void *, void **);
// ep_bind just does the bind() and listen() work,
// reserving the address but not creating any connections.
// It should return NNG_EADDRINUSE if the address is already
// taken. It can also return NNG_EBADADDR for an unsuitable
// address, or NNG_EACCESS for permission problems.
int (*ep_bind)(void *);
// ep_accept accepts an inbound connection, and creates
// a transport pipe, which is returned in the final argument.
int (*ep_accept)(void *, void **);
// ep_close stops the endpoint from operating altogether. It does
// not affect pipes that have already been created.
void (*ep_close)(void *);
// ep_setopt sets an endpoint (transport-specific) option.
int (*ep_setopt)(void *, int, const void *, size_t);
// ep_getopt gets an endpoint (transport-specific) option.
int (*ep_getopt)(void *, int, void *, size_t *);
};
// Pipe operations are entry points called by the socket. These may be called
// with socket locks held, so it is forbidden for the transport to call
// back into the socket at this point. (Which is one reason pointers back
// to socket or even enclosing pipe state, are not provided.)
struct nni_tran_pipe {
// p_destroy destroys the pipe. This should clean up all local
// resources, including closing files and freeing memory, used by
// the pipe. After this call returns, the system will not make
// further calls on the same pipe.
void (*pipe_destroy)(void *);
// p_send sends the message. If the message cannot be received, then
// the caller may try again with the same message (or free it). If
// the call succeeds, then the transport has taken ownership of the
// message, and the caller may not use it again. The transport will
// have the responsibility to free the message (nng_msg_free()) when
// it is finished with it.
int (*pipe_send)(void *, nni_msg *);
// p_recv recvs the message. This is a blocking operation, and a read
// will be performed even for cases where no data is expected. This
// allows the socket to detect a closed socket, by the returned error
// NNG_ECLOSED. Note that the closed socket condition can arise as
// either a result of a remote peer closing the connection, or a
// synchronous call to p_close.
int (*pipe_recv)(void *, nng_msg **);
// p_close closes the pipe. Further recv or send operations should
// return back NNG_ECLOSED.
void (*pipe_close)(void *);
// p_peer returns the peer protocol. This may arrive in whatever
// transport specific manner is appropriate.
uint16_t (*pipe_peer)(void *);
// p_getopt gets an pipe (transport-specific) property. These values
// may not be changed once the pipe is created.
int (*pipe_getopt)(void *, int, void *, size_t *);
};
// These APIs are used by the framework internally, and not for use by
// transport implementations.
extern nni_tran *nni_tran_find(const char *);
extern void nni_tran_init(void);
extern void nni_tran_fini(void);
#endif // CORE_TRANSPORT_H
|
