summaryrefslogtreecommitdiff
path: root/lib/tsocket/tsocket_internal.h
blob: e4a4908f3ea14d9f2904795d9cd54a222d5976ba (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
/*
   Unix SMB/CIFS implementation.

   Copyright (C) Stefan Metzmacher 2009

     ** NOTE! The following LGPL license applies to the tevent
     ** library. This does NOT imply that all of Samba is released
     ** under the LGPL

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 3 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _TSOCKET_INTERNAL_H
#define _TSOCKET_INTERNAL_H

struct tsocket_context_ops {
	const char *name;

	/* event handling */
	int (*set_event_context)(struct tsocket_context *sock,
				 struct tevent_context *ev);
	int (*set_read_handler)(struct tsocket_context *sock,
				tsocket_event_handler_t handler,
				void *private_data);
	int (*set_write_handler)(struct tsocket_context *sock,
				 tsocket_event_handler_t handler,
				 void *private_data);

	/* client ops */
	int (*connect_to)(struct tsocket_context *sock,
			  const struct tsocket_address *remote_addr);

	/* server ops */
	int (*listen_on)(struct tsocket_context *sock,
			 int queue_size);
	int (*accept_new)(struct tsocket_context *sock,
			  TALLOC_CTX *mem_ctx,
			  struct tsocket_context **new_sock,
			  const char *location);

	/* general ops */
	ssize_t (*pending_data)(struct tsocket_context *sock);

	int (*readv_data)(struct tsocket_context *sock,
			  const struct iovec *vector, size_t count);
	int (*writev_data)(struct tsocket_context *sock,
			   const struct iovec *vector, size_t count);

	ssize_t (*recvfrom_data)(struct tsocket_context *sock,
				 uint8_t *data, size_t len,
				 TALLOC_CTX *addr_ctx,
				 struct tsocket_address **remote_addr);
	ssize_t (*sendto_data)(struct tsocket_context *sock,
			       const uint8_t *data, size_t len,
			       const struct tsocket_address *remote_addr);

	/* info */
	int (*get_status)(const struct tsocket_context *sock);
	int (*get_local_address)(const struct tsocket_context *sock,
				TALLOC_CTX *mem_ctx,
				struct tsocket_address **local_addr,
				const char *location);
	int (*get_remote_address)(const struct tsocket_context *sock,
				  TALLOC_CTX *mem_ctx,
				  struct tsocket_address **remote_addr,
				  const char *location);

	/* options */
	int (*get_option)(const struct tsocket_context *sock,
			  const char *option,
			  TALLOC_CTX *mem_ctx,
			  char **value);
	int (*set_option)(const struct tsocket_context *sock,
			  const char *option,
			  bool force,
			  const char *value);

	/* close/disconnect */
	void (*disconnect)(struct tsocket_context *sock);
};

struct tsocket_context {
	const char *location;
	const struct tsocket_context_ops *ops;

	void *private_data;

	struct {
		struct tevent_context *ctx;
		void *read_private;
		tsocket_event_handler_t read_handler;
		void *write_private;
		tsocket_event_handler_t write_handler;
	} event;
};

struct tsocket_context *_tsocket_context_create(TALLOC_CTX *mem_ctx,
					const struct tsocket_context_ops *ops,
					void *pstate,
					size_t psize,
					const char *type,
					const char *location);
#define tsocket_context_create(mem_ctx, ops, state, type, location) \
	_tsocket_context_create(mem_ctx, ops, state, sizeof(type), \
				#type, location)

struct tsocket_address_ops {
	const char *name;

	char *(*string)(const struct tsocket_address *addr,
			TALLOC_CTX *mem_ctx);

	struct tsocket_address *(*copy)(const struct tsocket_address *addr,
					TALLOC_CTX *mem_ctx,
					const char *location);

	int (*create_socket)(const struct tsocket_address *addr,
			     enum tsocket_type,
			     TALLOC_CTX *mem_ctx,
			     struct tsocket_context **sock,
			     const char *location);
};

struct tsocket_address {
	const char *location;
	const struct tsocket_address_ops *ops;

	void *private_data;
};

struct tsocket_address *_tsocket_address_create(TALLOC_CTX *mem_ctx,
					const struct tsocket_address_ops *ops,
					void *pstate,
					size_t psize,
					const char *type,
					const char *location);
#define tsocket_address_create(mem_ctx, ops, state, type, location) \
	_tsocket_address_create(mem_ctx, ops, state, sizeof(type), \
				#type, location)

int tsocket_error_from_errno(int ret, int sys_errno, bool *retry);
int tsocket_simple_int_recv(struct tevent_req *req, int *perrno);
int tsocket_common_prepare_fd(int fd, bool high_fd);

#endif /* _TSOCKET_H */