aboutsummaryrefslogtreecommitdiff
path: root/src/protocol/pair/pair.c
blob: 9336af8c25a439c7dddd768ef043c87dee9e3f81 (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
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
//
// 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.
//

#include <stdlib.h>
#include <string.h>

#include "core/nng_impl.h"

// Pair protocol.  The PAIR protocol is a simple 1:1 messaging pattern.
// While a peer is connected to the server, all other peer connection
// attempts are discarded.

typedef struct nni_pair_pipe	nni_pair_pipe;
typedef struct nni_pair_sock	nni_pair_sock;

// An nni_pair_sock is our per-socket protocol private structure.
struct nni_pair_sock {
	nni_socket *	sock;
	nni_pair_pipe * pipe;
	nni_mtx		mx;
	nni_msgqueue *	uwq;
	nni_msgqueue *	urq;
};

// An nni_pair_pipe is our per-pipe protocol private structure.  We keep
// one of these even though in theory we'd only have a single underlying
// pipe.  The separate data structure is more like other protocols that do
// manage multiple pipes.
struct nni_pair_pipe {
	nni_pipe *	pipe;
	nni_pair_sock * pair;
	int		sigclose;
};

static void nni_pair_receiver(void *);
static void nni_pair_sender(void *);

static int
nni_pair_create(void **pairp, nni_socket *sock)
{
	nni_pair_sock *pair;
	int rv;

	if ((pair = nni_alloc(sizeof (*pair))) == NULL) {
		return (NNG_ENOMEM);
	}
	if ((rv = nni_mtx_init(&pair->mx)) != 0) {
		nni_free(pair, sizeof (*pair));
		return (rv);
	}
	pair->sock = sock;
	pair->pipe = NULL;
	pair->uwq = nni_socket_sendq(sock);
	pair->urq = nni_socket_recvq(sock);
	*pairp = pair;
	return (0);
}


static void
nni_pair_destroy(void *arg)
{
	nni_pair_sock *pair = arg;

	// If we had any worker threads that we have not unregistered,
	// this wold be the time to shut them all down.  We don't, because
	// the socket already shut us down, and we don't have any other
	// threads that run.
	nni_mtx_fini(&pair->mx);
	nni_free(pair, sizeof (*pair));
}


static int
nni_pair_add_pipe(void *arg, nni_pipe *pipe, void *data)
{
	nni_pair_sock *pair = arg;
	nni_pair_pipe *pp = data;
	int rv;

	pp->pipe = pipe;
	pp->sigclose = 0;
	pp->pair = pair;

	nni_mtx_lock(&pair->mx);
	if (pair->pipe != NULL) {
		nni_mtx_unlock(&pair->mx);
		return (NNG_EBUSY);      // Already have a peer, denied.
	}
	pair->pipe = pp;
	nni_mtx_unlock(&pair->mx);
	return (0);
}


static void
nni_pair_rem_pipe(void *arg, void *data)
{
	nni_pair_sock *pair = arg;
	nni_pair_pipe *pp = data;

	nni_mtx_lock(&pair->mx);
	if (pair->pipe == pp) {
		pair->pipe = NULL;
	}
	nni_mtx_unlock(&pair->mx);
}


static void
nni_pair_sender(void *arg)
{
	nni_pair_pipe *pp = arg;
	nni_pair_sock *pair = pp->pair;
	nni_msgqueue *uwq = pair->uwq;
	nni_msgqueue *urq = pair->urq;
	nni_pipe *pipe = pp->pipe;
	nni_msg *msg;
	int rv;

	for (;;) {
		rv = nni_msgqueue_get_sig(uwq, &msg, &pp->sigclose);
		if (rv != 0) {
			break;
		}
		rv = nni_pipe_send(pipe, msg);
		if (rv != 0) {
			nni_msg_free(msg);
			break;
		}
	}
	nni_msgqueue_signal(urq, &pp->sigclose);
	nni_pipe_close(pipe);
}


static void
nni_pair_receiver(void *arg)
{
	nni_pair_pipe *pp = arg;
	nni_pair_sock *pair = pp->pair;
	nni_msgqueue *urq = pair->urq;
	nni_msgqueue *uwq = pair->uwq;
	nni_pipe *pipe = pp->pipe;
	nni_msg *msg;
	int rv;

	for (;;) {
		rv = nni_pipe_recv(pipe, &msg);
		if (rv != 0) {
			break;
		}
		rv = nni_msgqueue_put_sig(urq, msg, &pp->sigclose);
		if (rv != 0) {
			nni_msg_free(msg);
			break;
		}
	}
	nni_msgqueue_signal(uwq, &pp->sigclose);
	nni_pipe_close(pipe);
}


// TODO: probably we could replace these with NULL, since we have no
// protocol specific options?
static int
nni_pair_setopt(void *arg, int opt, const void *buf, size_t sz)
{
	return (NNG_ENOTSUP);
}


static int
nni_pair_getopt(void *arg, int opt, void *buf, size_t *szp)
{
	return (NNG_ENOTSUP);
}


// This is the global protocol structure -- our linkage to the core.
// This should be the only global non-static symbol in this file.
struct nni_protocol nni_pair_protocol = {
	.proto_self		= NNG_PROTO_PAIR,
	.proto_peer		= NNG_PROTO_PAIR,
	.proto_name		= "pair",
	.proto_create		= nni_pair_create,
	.proto_destroy		= nni_pair_destroy,
	.proto_add_pipe		= nni_pair_add_pipe,
	.proto_rem_pipe		= nni_pair_rem_pipe,
	.proto_pipe_size	= sizeof (nni_pair_pipe),
	.proto_pipe_send	= nni_pair_sender,
	.proto_pipe_recv	= nni_pair_receiver,
	.proto_setopt		= nni_pair_setopt,
	.proto_getopt		= nni_pair_getopt,
	.proto_recv_filter	= NULL,
	.proto_send_filter	= NULL,
};