You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
176 lines
6.4 KiB
176 lines
6.4 KiB
/* =========================================================================
|
|
zframe - working with single message frames
|
|
|
|
Copyright (c) the Contributors as noted in the AUTHORS file.
|
|
This file is part of CZMQ, the high-level C binding for 0MQ:
|
|
http://czmq.zeromq.org.
|
|
|
|
This Source Code Form is subject to the terms of the Mozilla Public
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
=========================================================================
|
|
*/
|
|
|
|
#ifndef __ZFRAME_H_INCLUDED__
|
|
#define __ZFRAME_H_INCLUDED__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
// @warning THE FOLLOWING @INTERFACE BLOCK IS AUTO-GENERATED BY ZPROJECT
|
|
// @warning Please edit the model at "api/zframe.api" to make changes.
|
|
// @interface
|
|
// This is a stable class, and may not change except for emergencies. It
|
|
// is provided in stable builds.
|
|
// This class has draft methods, which may change over time. They are not
|
|
// in stable releases, by default. Use --enable-drafts to enable.
|
|
#define ZFRAME_MORE 1 //
|
|
#define ZFRAME_REUSE 2 //
|
|
#define ZFRAME_DONTWAIT 4 //
|
|
|
|
// Create a new frame. If size is not null, allocates the frame data
|
|
// to the specified size. If additionally, data is not null, copies
|
|
// size octets from the specified data into the frame body.
|
|
CZMQ_EXPORT zframe_t *
|
|
zframe_new (const void *data, size_t size);
|
|
|
|
// Create an empty (zero-sized) frame
|
|
CZMQ_EXPORT zframe_t *
|
|
zframe_new_empty (void);
|
|
|
|
// Create a frame with a specified string content.
|
|
CZMQ_EXPORT zframe_t *
|
|
zframe_from (const char *string);
|
|
|
|
// Receive frame from socket, returns zframe_t object or NULL if the recv
|
|
// was interrupted. Does a blocking recv, if you want to not block then use
|
|
// zpoller or zloop.
|
|
CZMQ_EXPORT zframe_t *
|
|
zframe_recv (void *source);
|
|
|
|
// Destroy a frame
|
|
CZMQ_EXPORT void
|
|
zframe_destroy (zframe_t **self_p);
|
|
|
|
// Send a frame to a socket, destroy frame after sending.
|
|
// Return -1 on error, 0 on success.
|
|
CZMQ_EXPORT int
|
|
zframe_send (zframe_t **self_p, void *dest, int flags);
|
|
|
|
// Return number of bytes in frame data
|
|
CZMQ_EXPORT size_t
|
|
zframe_size (zframe_t *self);
|
|
|
|
// Return address of frame data
|
|
CZMQ_EXPORT byte *
|
|
zframe_data (zframe_t *self);
|
|
|
|
// Return meta data property for frame
|
|
// Caller must free string when finished with it.
|
|
CZMQ_EXPORT const char *
|
|
zframe_meta (zframe_t *self, const char *property);
|
|
|
|
// Create a new frame that duplicates an existing frame. If frame is null,
|
|
// or memory was exhausted, returns null.
|
|
// Caller owns return value and must destroy it when done.
|
|
CZMQ_EXPORT zframe_t *
|
|
zframe_dup (zframe_t *self);
|
|
|
|
// Return frame data encoded as printable hex string, useful for 0MQ UUIDs.
|
|
// Caller must free string when finished with it.
|
|
// Caller owns return value and must destroy it when done.
|
|
CZMQ_EXPORT char *
|
|
zframe_strhex (zframe_t *self);
|
|
|
|
// Return frame data copied into freshly allocated string
|
|
// Caller must free string when finished with it.
|
|
// Caller owns return value and must destroy it when done.
|
|
CZMQ_EXPORT char *
|
|
zframe_strdup (zframe_t *self);
|
|
|
|
// Return TRUE if frame body is equal to string, excluding terminator
|
|
CZMQ_EXPORT bool
|
|
zframe_streq (zframe_t *self, const char *string);
|
|
|
|
// Return frame MORE indicator (1 or 0), set when reading frame from socket
|
|
// or by the zframe_set_more() method
|
|
CZMQ_EXPORT int
|
|
zframe_more (zframe_t *self);
|
|
|
|
// Set frame MORE indicator (1 or 0). Note this is NOT used when sending
|
|
// frame to socket, you have to specify flag explicitly.
|
|
CZMQ_EXPORT void
|
|
zframe_set_more (zframe_t *self, int more);
|
|
|
|
// Return TRUE if two frames have identical size and data
|
|
// If either frame is NULL, equality is always false.
|
|
CZMQ_EXPORT bool
|
|
zframe_eq (zframe_t *self, zframe_t *other);
|
|
|
|
// Set new contents for frame
|
|
CZMQ_EXPORT void
|
|
zframe_reset (zframe_t *self, const void *data, size_t size);
|
|
|
|
// Send message to zsys log sink (may be stdout, or system facility as
|
|
// configured by zsys_set_logstream). Prefix shows before frame, if not null.
|
|
CZMQ_EXPORT void
|
|
zframe_print (zframe_t *self, const char *prefix);
|
|
|
|
// Probe the supplied object, and report if it looks like a zframe_t.
|
|
CZMQ_EXPORT bool
|
|
zframe_is (void *self);
|
|
|
|
// Self test of this class.
|
|
CZMQ_EXPORT void
|
|
zframe_test (bool verbose);
|
|
|
|
#ifdef CZMQ_BUILD_DRAFT_API
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Return frame routing ID, if the frame came from a ZMQ_SERVER socket.
|
|
// Else returns zero.
|
|
CZMQ_EXPORT uint32_t
|
|
zframe_routing_id (zframe_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Set routing ID on frame. This is used if/when the frame is sent to a
|
|
// ZMQ_SERVER socket.
|
|
CZMQ_EXPORT void
|
|
zframe_set_routing_id (zframe_t *self, uint32_t routing_id);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Return frame group of radio-dish pattern.
|
|
CZMQ_EXPORT const char *
|
|
zframe_group (zframe_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Set group on frame. This is used if/when the frame is sent to a
|
|
// ZMQ_RADIO socket.
|
|
// Return -1 on error, 0 on success.
|
|
CZMQ_EXPORT int
|
|
zframe_set_group (zframe_t *self, const char *group);
|
|
|
|
#endif // CZMQ_BUILD_DRAFT_API
|
|
// @end
|
|
|
|
|
|
// DEPRECATED as poor style -- callers should use zloop or zpoller
|
|
// Receive a new frame off the socket. Returns newly allocated frame, or
|
|
// NULL if there was no input waiting, or if the read was interrupted.
|
|
CZMQ_EXPORT zframe_t *
|
|
zframe_recv_nowait (void *source);
|
|
|
|
// DEPRECATED as inconsistent; breaks principle that logging should all go
|
|
// to a single destination.
|
|
// Print contents of the frame to FILE stream.
|
|
CZMQ_EXPORT void
|
|
zframe_fprint (zframe_t *self, const char *prefix, FILE *file);
|
|
|
|
// Deprecated method aliases
|
|
#define zframe_print_to_stream(s,p,F) zframe_fprint(s,p,F)
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|