aboutsummaryrefslogtreecommitdiff
path: root/src/core/pipe.h
blob: 4bd11a17cb7555700da0f32875d5f6527ec5d3cb (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
//
// 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_PIPE_H
#define CORE_PIPE_H

// NB: This structure is supplied here for use by the CORE. Use of this
// OUSIDE of the core is STRICTLY VERBOTEN.  NO DIRECT ACCESS BY PROTOCOLS OR
// TRANSPORTS.

#include "core/transport.h"

struct nng_pipe {
	uint32_t		p_id;
	struct nni_pipe_ops	p_ops;
	void *			p_data;
	nni_list_node		p_sock_node;
	nni_socket *		p_sock;
	nni_endpt *		p_ep;
};

 // Pipe operations that protocols use.
extern int nni_pipe_recv(nni_pipe *, nng_msg **);
extern int nni_pipe_send(nni_pipe *, nng_msg *);
extern uint32_t nni_pipe_id(nni_pipe *);
extern void nni_pipe_close(nni_pipe *);

// Used only by the socket core - as we don't wish to expose the details
// of the pipe structure outside of pipe.c.
extern int nni_pipe_create(nni_pipe **, const nni_pipe_ops *);

extern void nni_pipe_destroy(nni_pipe *);

#endif // CORE_PIPE_H