31 | 31 |
|
32 | 32 |
// *** Draft method, defined for internal use only ***
|
33 | 33 |
// Unset certificate metadata.
|
34 | |
CZMQ_EXPORT void
|
|
34 |
CZMQ_PRIVATE void
|
35 | 35 |
zcert_unset_meta (zcert_t *self, const char *name);
|
36 | 36 |
|
37 | 37 |
// *** Draft callbacks, defined for internal use only ***
|
|
44 | 44 |
|
45 | 45 |
// *** Draft method, defined for internal use only ***
|
46 | 46 |
// Override the default disk loader with a custom loader fn.
|
47 | |
CZMQ_EXPORT void
|
|
47 |
CZMQ_PRIVATE void
|
48 | 48 |
zcertstore_set_loader (zcertstore_t *self, zcertstore_loader loader, zcertstore_destructor destructor, void *state);
|
49 | 49 |
|
50 | 50 |
// *** Draft method, defined for internal use only ***
|
51 | 51 |
// Empty certificate hashtable. This wrapper exists to be friendly to bindings,
|
52 | 52 |
// which don't usually have access to struct internals.
|
53 | |
CZMQ_EXPORT void
|
|
53 |
CZMQ_PRIVATE void
|
54 | 54 |
zcertstore_empty (zcertstore_t *self);
|
55 | 55 |
|
56 | 56 |
// *** Draft method, defined for internal use only ***
|
57 | 57 |
// Return frame routing ID, if the frame came from a ZMQ_SERVER socket.
|
58 | 58 |
// Else returns zero.
|
59 | |
CZMQ_EXPORT uint32_t
|
|
59 |
CZMQ_PRIVATE uint32_t
|
60 | 60 |
zframe_routing_id (zframe_t *self);
|
61 | 61 |
|
62 | 62 |
// *** Draft method, defined for internal use only ***
|
63 | 63 |
// Set routing ID on frame. This is used if/when the frame is sent to a
|
64 | 64 |
// ZMQ_SERVER socket.
|
65 | |
CZMQ_EXPORT void
|
|
65 |
CZMQ_PRIVATE void
|
66 | 66 |
zframe_set_routing_id (zframe_t *self, uint32_t routing_id);
|
67 | 67 |
|
68 | 68 |
// *** Draft method, defined for internal use only ***
|
69 | 69 |
// Return frame group of radio-dish pattern.
|
70 | |
CZMQ_EXPORT const char *
|
|
70 |
CZMQ_PRIVATE const char *
|
71 | 71 |
zframe_group (zframe_t *self);
|
72 | 72 |
|
73 | 73 |
// *** Draft method, defined for internal use only ***
|
74 | 74 |
// Set group on frame. This is used if/when the frame is sent to a
|
75 | 75 |
// ZMQ_RADIO socket.
|
76 | 76 |
// Return -1 on error, 0 on success.
|
77 | |
CZMQ_EXPORT int
|
|
77 |
CZMQ_PRIVATE int
|
78 | 78 |
zframe_set_group (zframe_t *self, const char *group);
|
79 | 79 |
|
80 | 80 |
// *** Draft method, defined for internal use only ***
|
81 | 81 |
// Same as pack but uses a user-defined serializer function to convert items
|
82 | 82 |
// into longstr.
|
83 | 83 |
// Caller owns return value and must destroy it when done.
|
84 | |
CZMQ_EXPORT zframe_t *
|
|
84 |
CZMQ_PRIVATE zframe_t *
|
85 | 85 |
zhashx_pack_own (zhashx_t *self, zhashx_serializer_fn serializer);
|
86 | 86 |
|
87 | 87 |
// *** Draft method, defined for internal use only ***
|
88 | 88 |
// Same as unpack but uses a user-defined deserializer function to convert
|
89 | 89 |
// a longstr back into item format.
|
90 | 90 |
// Caller owns return value and must destroy it when done.
|
91 | |
CZMQ_EXPORT zhashx_t *
|
|
91 |
CZMQ_PRIVATE zhashx_t *
|
92 | 92 |
zhashx_unpack_own (zframe_t *frame, zhashx_deserializer_fn deserializer);
|
93 | 93 |
|
94 | 94 |
// *** Draft method, defined for internal use only ***
|
95 | 95 |
// Return message routing ID, if the message came from a ZMQ_SERVER socket.
|
96 | 96 |
// Else returns zero.
|
97 | |
CZMQ_EXPORT uint32_t
|
|
97 |
CZMQ_PRIVATE uint32_t
|
98 | 98 |
zmsg_routing_id (zmsg_t *self);
|
99 | 99 |
|
100 | 100 |
// *** Draft method, defined for internal use only ***
|
101 | 101 |
// Set routing ID on message. This is used if/when the message is sent to a
|
102 | 102 |
// ZMQ_SERVER socket.
|
103 | |
CZMQ_EXPORT void
|
|
103 |
CZMQ_PRIVATE void
|
104 | 104 |
zmsg_set_routing_id (zmsg_t *self, uint32_t routing_id);
|
105 | 105 |
|
106 | 106 |
// *** Draft method, defined for internal use only ***
|
107 | 107 |
// Create a SERVER socket. Default action is bind.
|
108 | 108 |
// Caller owns return value and must destroy it when done.
|
109 | |
CZMQ_EXPORT zsock_t *
|
|
109 |
CZMQ_PRIVATE zsock_t *
|
110 | 110 |
zsock_new_server (const char *endpoint);
|
111 | 111 |
|
112 | 112 |
// *** Draft method, defined for internal use only ***
|
113 | 113 |
// Create a CLIENT socket. Default action is connect.
|
114 | 114 |
// Caller owns return value and must destroy it when done.
|
115 | |
CZMQ_EXPORT zsock_t *
|
|
115 |
CZMQ_PRIVATE zsock_t *
|
116 | 116 |
zsock_new_client (const char *endpoint);
|
117 | 117 |
|
118 | 118 |
// *** Draft method, defined for internal use only ***
|
119 | 119 |
// Create a RADIO socket. Default action is bind.
|
120 | 120 |
// Caller owns return value and must destroy it when done.
|
121 | |
CZMQ_EXPORT zsock_t *
|
|
121 |
CZMQ_PRIVATE zsock_t *
|
122 | 122 |
zsock_new_radio (const char *endpoint);
|
123 | 123 |
|
124 | 124 |
// *** Draft method, defined for internal use only ***
|
125 | 125 |
// Create a DISH socket. Default action is connect.
|
126 | 126 |
// Caller owns return value and must destroy it when done.
|
127 | |
CZMQ_EXPORT zsock_t *
|
|
127 |
CZMQ_PRIVATE zsock_t *
|
128 | 128 |
zsock_new_dish (const char *endpoint);
|
129 | 129 |
|
130 | 130 |
// *** Draft method, defined for internal use only ***
|
131 | 131 |
// Create a GATHER socket. Default action is bind.
|
132 | 132 |
// Caller owns return value and must destroy it when done.
|
133 | |
CZMQ_EXPORT zsock_t *
|
|
133 |
CZMQ_PRIVATE zsock_t *
|
134 | 134 |
zsock_new_gather (const char *endpoint);
|
135 | 135 |
|
136 | 136 |
// *** Draft method, defined for internal use only ***
|
137 | 137 |
// Create a SCATTER socket. Default action is connect.
|
138 | 138 |
// Caller owns return value and must destroy it when done.
|
139 | |
CZMQ_EXPORT zsock_t *
|
|
139 |
CZMQ_PRIVATE zsock_t *
|
140 | 140 |
zsock_new_scatter (const char *endpoint);
|
141 | 141 |
|
142 | 142 |
// *** Draft method, defined for internal use only ***
|
143 | 143 |
// Return socket routing ID if any. This returns 0 if the socket is not
|
144 | 144 |
// of type ZMQ_SERVER or if no request was already received on it.
|
145 | |
CZMQ_EXPORT uint32_t
|
|
145 |
CZMQ_PRIVATE uint32_t
|
146 | 146 |
zsock_routing_id (zsock_t *self);
|
147 | 147 |
|
148 | 148 |
// *** Draft method, defined for internal use only ***
|
149 | 149 |
// Set routing ID on socket. The socket MUST be of type ZMQ_SERVER.
|
150 | 150 |
// This will be used when sending messages on the socket via the zsock API.
|
151 | |
CZMQ_EXPORT void
|
|
151 |
CZMQ_PRIVATE void
|
152 | 152 |
zsock_set_routing_id (zsock_t *self, uint32_t routing_id);
|
153 | 153 |
|
154 | 154 |
// *** Draft method, defined for internal use only ***
|
155 | 155 |
// Join a group for the RADIO-DISH pattern. Call only on ZMQ_DISH.
|
156 | 156 |
// Returns 0 if OK, -1 if failed.
|
157 | |
CZMQ_EXPORT int
|
|
157 |
CZMQ_PRIVATE int
|
158 | 158 |
zsock_join (void *self, const char *group);
|
159 | 159 |
|
160 | 160 |
// *** Draft method, defined for internal use only ***
|
161 | 161 |
// Leave a group for the RADIO-DISH pattern. Call only on ZMQ_DISH.
|
162 | 162 |
// Returns 0 if OK, -1 if failed.
|
163 | |
CZMQ_EXPORT int
|
|
163 |
CZMQ_PRIVATE int
|
164 | 164 |
zsock_leave (void *self, const char *group);
|
165 | 165 |
|
166 | 166 |
// *** Draft method, defined for internal use only ***
|
167 | 167 |
// Accepts a void pointer and returns a fresh character string. If source
|
168 | 168 |
// is null, returns an empty string.
|
169 | 169 |
// Caller owns return value and must destroy it when done.
|
170 | |
CZMQ_EXPORT char *
|
|
170 |
CZMQ_PRIVATE char *
|
171 | 171 |
zstr_str (void *source);
|
172 | 172 |
|
173 | 173 |
// *** Draft constants, defined for internal use only ***
|
|
180 | 180 |
// *** Draft method, defined for internal use only ***
|
181 | 181 |
// Create a new empty zgossip_msg
|
182 | 182 |
// Caller owns return value and must destroy it when done.
|
183 | |
CZMQ_EXPORT zgossip_msg_t *
|
|
183 |
CZMQ_PRIVATE zgossip_msg_t *
|
184 | 184 |
zgossip_msg_new (void);
|
185 | 185 |
|
186 | 186 |
// *** Draft method, defined for internal use only ***
|
187 | 187 |
// Destroy a zgossip_msg instance
|
188 | |
CZMQ_EXPORT void
|
|
188 |
CZMQ_PRIVATE void
|
189 | 189 |
zgossip_msg_destroy (zgossip_msg_t **self_p);
|
190 | 190 |
|
191 | 191 |
// *** Draft method, defined for internal use only ***
|
192 | 192 |
// Receive a zgossip_msg from the socket. Returns 0 if OK, -1 if
|
193 | 193 |
// there was an error. Blocks if there is no message waiting.
|
194 | |
CZMQ_EXPORT int
|
|
194 |
CZMQ_PRIVATE int
|
195 | 195 |
zgossip_msg_recv (zgossip_msg_t *self, zsock_t *input);
|
196 | 196 |
|
197 | 197 |
// *** Draft method, defined for internal use only ***
|
198 | 198 |
// Send the zgossip_msg to the output socket, does not destroy it
|
199 | |
CZMQ_EXPORT int
|
|
199 |
CZMQ_PRIVATE int
|
200 | 200 |
zgossip_msg_send (zgossip_msg_t *self, zsock_t *output);
|
201 | 201 |
|
202 | 202 |
// *** Draft method, defined for internal use only ***
|
203 | 203 |
// Print contents of message to stdout
|
204 | |
CZMQ_EXPORT void
|
|
204 |
CZMQ_PRIVATE void
|
205 | 205 |
zgossip_msg_print (zgossip_msg_t *self);
|
206 | 206 |
|
207 | 207 |
// *** Draft method, defined for internal use only ***
|
208 | 208 |
// Get the message routing id, as a frame
|
209 | |
CZMQ_EXPORT zframe_t *
|
|
209 |
CZMQ_PRIVATE zframe_t *
|
210 | 210 |
zgossip_msg_routing_id (zgossip_msg_t *self);
|
211 | 211 |
|
212 | 212 |
// *** Draft method, defined for internal use only ***
|
213 | 213 |
// Set the message routing id from a frame
|
214 | |
CZMQ_EXPORT void
|
|
214 |
CZMQ_PRIVATE void
|
215 | 215 |
zgossip_msg_set_routing_id (zgossip_msg_t *self, zframe_t *routing_id);
|
216 | 216 |
|
217 | 217 |
// *** Draft method, defined for internal use only ***
|
218 | 218 |
// Get the zgossip_msg message id
|
219 | |
CZMQ_EXPORT int
|
|
219 |
CZMQ_PRIVATE int
|
220 | 220 |
zgossip_msg_id (zgossip_msg_t *self);
|
221 | 221 |
|
222 | 222 |
// *** Draft method, defined for internal use only ***
|
223 | 223 |
// Set the zgossip_msg message id
|
224 | |
CZMQ_EXPORT void
|
|
224 |
CZMQ_PRIVATE void
|
225 | 225 |
zgossip_msg_set_id (zgossip_msg_t *self, int id);
|
226 | 226 |
|
227 | 227 |
// *** Draft method, defined for internal use only ***
|
228 | 228 |
// Get the zgossip_msg message id as printable text
|
229 | |
CZMQ_EXPORT const char *
|
|
229 |
CZMQ_PRIVATE const char *
|
230 | 230 |
zgossip_msg_command (zgossip_msg_t *self);
|
231 | 231 |
|
232 | 232 |
// *** Draft method, defined for internal use only ***
|
233 | 233 |
// Get the key field
|
234 | |
CZMQ_EXPORT const char *
|
|
234 |
CZMQ_PRIVATE const char *
|
235 | 235 |
zgossip_msg_key (zgossip_msg_t *self);
|
236 | 236 |
|
237 | 237 |
// *** Draft method, defined for internal use only ***
|
238 | 238 |
// Set the key field
|
239 | |
CZMQ_EXPORT void
|
|
239 |
CZMQ_PRIVATE void
|
240 | 240 |
zgossip_msg_set_key (zgossip_msg_t *self, const char *key);
|
241 | 241 |
|
242 | 242 |
// *** Draft method, defined for internal use only ***
|
243 | 243 |
// Get the value field
|
244 | |
CZMQ_EXPORT const char *
|
|
244 |
CZMQ_PRIVATE const char *
|
245 | 245 |
zgossip_msg_value (zgossip_msg_t *self);
|
246 | 246 |
|
247 | 247 |
// *** Draft method, defined for internal use only ***
|
248 | 248 |
// Set the value field
|
249 | |
CZMQ_EXPORT void
|
|
249 |
CZMQ_PRIVATE void
|
250 | 250 |
zgossip_msg_set_value (zgossip_msg_t *self, const char *value);
|
251 | 251 |
|
252 | 252 |
// *** Draft method, defined for internal use only ***
|
253 | 253 |
// Get the ttl field
|
254 | |
CZMQ_EXPORT uint32_t
|
|
254 |
CZMQ_PRIVATE uint32_t
|
255 | 255 |
zgossip_msg_ttl (zgossip_msg_t *self);
|
256 | 256 |
|
257 | 257 |
// *** Draft method, defined for internal use only ***
|
258 | 258 |
// Set the ttl field
|
259 | |
CZMQ_EXPORT void
|
|
259 |
CZMQ_PRIVATE void
|
260 | 260 |
zgossip_msg_set_ttl (zgossip_msg_t *self, uint32_t ttl);
|
261 | 261 |
|
262 | 262 |
// *** Draft method, defined for internal use only ***
|
263 | 263 |
// Self test of this class.
|
264 | |
CZMQ_EXPORT void
|
|
264 |
CZMQ_PRIVATE void
|
265 | 265 |
zgossip_msg_test (bool verbose);
|
266 | 266 |
|
267 | 267 |
#endif // CZMQ_BUILD_DRAFT_API
|