Group types¶

Modules¶

Type	Name
module	Sample C types
module	Wire constants

Classes¶

Type	Name
struct	dp_chunk_t Reassembly geometry, present only when DP_FLAG_CHUNKED .
struct	dp_header_t Frame metadata carried in every stream message.

Public Types¶

Type	Name
enum	dp_frame_kind_t What a frame's payload IS, independent of how its elements are encoded.
typedef struct dp_msg	dp_msg_t Opaque zero-copy message handle returned by recv functions.
typedef struct dp_ctx	dp_pub_t Opaque streaming socket handle returned by all create functions.
typedef struct dp_ctx	dp_pull_t
typedef struct dp_ctx	dp_push_t
typedef struct dp_ctx	dp_rep_t
typedef struct dp_ctx	dp_req_t
typedef struct dp_ctx	dp_sub_t

Public Types Documentation¶

enum dp_frame_kind_t¶

What a frame's payload IS, independent of how its elements are encoded.

enum dp_frame_kind_t {
    DP_KIND_IQ = 0,
    DP_KIND_TLM = 1,
    DP_KIND_EOS = 2
};

TLM16 used to be a sixth dp_sample_type_t, which made every I/Q-only sender carry an exception for it and left the format field holding a value BLUE does not define. Telemetry is not a sample encoding, it is a different kind of frame, so it says so here and the format field stays purely a BLUE sample code.

typedef dp_msg_t¶

Opaque zero-copy message handle returned by recv functions.

typedef struct dp_msg dp_msg_t;

The data buffer is valid until dp_msg_free() is called. Use the accessor functions to retrieve a pointer to the sample data, size, etc.

typedef dp_pub_t¶

Opaque streaming socket handle returned by all create functions.

typedef struct dp_ctx dp_pub_t;

typedef dp_pull_t¶

typedef struct dp_ctx dp_pull_t;

typedef dp_push_t¶

typedef struct dp_ctx dp_push_t;

typedef dp_rep_t¶

typedef struct dp_ctx dp_rep_t;

typedef dp_req_t¶

typedef struct dp_ctx dp_req_t;

typedef dp_sub_t¶

typedef struct dp_ctx dp_sub_t;