aboutsummaryrefslogtreecommitdiff
path: root/src/protocol/pipeline/pull.c
blob: 7dd0c8ed8f09d9862fee0fa1f8e719f9654ad2b5 (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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
//
// Copyright 2017 Garrett D'Amore <garrett@damore.org>
// Copyright 2017 Capitar IT Group BV <info@capitar.com>
//
// 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"

// Pull protocol.  The PULL protocol is the "read" side of a pipeline.

typedef struct pull_pipe pull_pipe;
typedef struct pull_sock pull_sock;

static void pull_putq_cb(void *);
static void pull_recv_cb(void *);
static void pull_putq(pull_pipe *, nni_msg *);

// A pull_sock is our per-socket protocol private structure.
struct pull_sock {
	nni_msgq *urq;
	int       raw;
	nni_sock *sock;
};

// A pull_pipe is our per-pipe protocol private structure.
struct pull_pipe {
	nni_pipe * pipe;
	pull_sock *pull;
	nni_aio *  putq_aio;
	nni_aio *  recv_aio;
};

static int
pull_sock_init(void **sp, nni_sock *sock)
{
	pull_sock *s;

	if ((s = NNI_ALLOC_STRUCT(s)) == NULL) {
		return (NNG_ENOMEM);
	}
	s->raw  = 0;
	s->urq  = nni_sock_recvq(sock);
	s->sock = sock;

	*sp = s;
	return (0);
}

static void
pull_sock_fini(void *arg)
{
	pull_sock *s = arg;

	NNI_FREE_STRUCT(s);
}

static void
pull_pipe_fini(void *arg)
{
	pull_pipe *p = arg;

	nni_aio_fini(p->putq_aio);
	nni_aio_fini(p->recv_aio);
	NNI_FREE_STRUCT(p);
}

static int
pull_pipe_init(void **pp, nni_pipe *pipe, void *s)
{
	pull_pipe *p;
	int        rv;

	if ((p = NNI_ALLOC_STRUCT(p)) == NULL) {
		return (NNG_ENOMEM);
	}
	if (((rv = nni_aio_init(&p->putq_aio, pull_putq_cb, p)) != 0) ||
	    ((rv = nni_aio_init(&p->recv_aio, pull_recv_cb, p)) != 0)) {
		pull_pipe_fini(p);
		return (rv);
	}

	p->pipe = pipe;
	p->pull = s;
	*pp     = p;
	return (0);
}

static int
pull_pipe_start(void *arg)
{
	pull_pipe *p = arg;

	// Start the pending pull...
	nni_pipe_recv(p->pipe, p->recv_aio);

	return (0);
}

static void
pull_pipe_stop(void *arg)
{
	pull_pipe *p = arg;

	nni_aio_stop(p->putq_aio);
	nni_aio_stop(p->recv_aio);
}

static void
pull_recv_cb(void *arg)
{
	pull_pipe *p   = arg;
	nni_aio *  aio = p->recv_aio;
	nni_msg *  msg;

	if (nni_aio_result(aio) != 0) {
		// Failed to get a message, probably the pipe is closed.
		nni_pipe_stop(p->pipe);
		return;
	}

	// Got a message... start the put to send it up to the application.
	msg = nni_aio_get_msg(aio);
	nni_msg_set_pipe(msg, nni_pipe_id(p->pipe));
	nni_aio_set_msg(aio, NULL);
	pull_putq(p, msg);
}

static void
pull_putq_cb(void *arg)
{
	pull_pipe *p   = arg;
	nni_aio *  aio = p->putq_aio;

	if (nni_aio_result(aio) != 0) {
		// If we failed to put, probably NNG_ECLOSED, nothing else
		// we can do.  Just close the pipe.
		nni_msg_free(nni_aio_get_msg(aio));
		nni_aio_set_msg(aio, NULL);
		nni_pipe_stop(p->pipe);
		return;
	}

	nni_pipe_recv(p->pipe, p->recv_aio);
}

// nni_pull_putq schedules a put operation to the user socket (sendup).
static void
pull_putq(pull_pipe *p, nni_msg *msg)
{
	pull_sock *s = p->pull;

	nni_aio_set_msg(p->putq_aio, msg);

	nni_msgq_aio_put(s->urq, p->putq_aio);
}

static void
pull_sock_open(void *arg)
{
	NNI_ARG_UNUSED(arg);
}

static void
pull_sock_close(void *arg)
{
	NNI_ARG_UNUSED(arg);
}

static int
pull_sock_setopt_raw(void *arg, const void *buf, size_t sz)
{
	pull_sock *s = arg;
	return (nni_setopt_int(&s->raw, buf, sz, 0, 1));
}

static int
pull_sock_getopt_raw(void *arg, void *buf, size_t *szp)
{
	pull_sock *s = arg;
	return (nni_getopt_int(s->raw, buf, szp));
}

static void
pull_sock_send(void *arg, nni_aio *aio)
{
	nni_aio_finish_error(aio, NNG_ENOTSUP);
}

static void
pull_sock_recv(void *arg, nni_aio *aio)
{
	pull_sock *s = arg;

	nni_sock_recv_pending(s->sock);
	nni_msgq_aio_get(s->urq, aio);
}

static nni_proto_pipe_ops pull_pipe_ops = {
	.pipe_init  = pull_pipe_init,
	.pipe_fini  = pull_pipe_fini,
	.pipe_start = pull_pipe_start,
	.pipe_stop  = pull_pipe_stop,
};

static nni_proto_sock_option pull_sock_options[] = {
	{
	    .pso_name   = NNG_OPT_RAW,
	    .pso_getopt = pull_sock_getopt_raw,
	    .pso_setopt = pull_sock_setopt_raw,
	},
	// terminate list
	{ NULL, NULL, NULL },
};

static nni_proto_sock_ops pull_sock_ops = {
	.sock_init    = pull_sock_init,
	.sock_fini    = pull_sock_fini,
	.sock_open    = pull_sock_open,
	.sock_close   = pull_sock_close,
	.sock_send    = pull_sock_send,
	.sock_recv    = pull_sock_recv,
	.sock_options = pull_sock_options,
};

static nni_proto pull_proto = {
	.proto_version  = NNI_PROTOCOL_VERSION,
	.proto_self     = { NNG_PROTO_PULL_V0, "pull" },
	.proto_peer     = { NNG_PROTO_PUSH_V0, "push" },
	.proto_flags    = NNI_PROTO_FLAG_RCV,
	.proto_pipe_ops = &pull_pipe_ops,
	.proto_sock_ops = &pull_sock_ops,
};

int
nng_pull0_open(nng_socket *sidp)
{
	return (nni_proto_open(sidp, &pull_proto));
}