NVIDIA DeepStream SDK API Reference

5.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvds_msgapi.h File Reference

Detailed Description

DeepStream Messaging API

Description: This file defines the DeepStream API for exchanging messages with remote entities and services.

Definition in file nvds_msgapi.h.

Go to the source code of this file.


typedef void * NvDsMsgApiHandle
 Defines the handle used by messaging API functions. More...
typedef void(* nvds_msgapi_send_cb_t )(void *user_ptr, NvDsMsgApiErrorType completion_flag)
 Type definition for a "send" callback. More...
typedef void(* nvds_msgapi_subscribe_request_cb_t )(NvDsMsgApiErrorType flag, void *msg, int msg_len, char *topic, void *user_ptr)
 Type definition for callback registered during subscribe. More...
typedef void(* nvds_msgapi_connect_cb_t )(NvDsMsgApiHandle h_ptr, NvDsMsgApiEventType ds_evt)
 Type definition for a "handle" callback. More...


enum  NvDsMsgApiEventType {
 Defines events associated with connections to remote entities. More...
enum  NvDsMsgApiErrorType {
 Defines completion codes for operations in the messaging API. More...


NvDsMsgApiHandle nvds_msgapi_connect (char *connection_str, nvds_msgapi_connect_cb_t connect_cb, char *config_path)
 Connects to a remote agent by calling into a protocol adapter. More...
NvDsMsgApiErrorType nvds_msgapi_send (NvDsMsgApiHandle h_ptr, char *topic, const uint8_t *payload, size_t nbuf)
 Sends a message synchronously over a connection. More...
NvDsMsgApiErrorType nvds_msgapi_send_async (NvDsMsgApiHandle h_ptr, char *topic, const uint8_t *payload, size_t nbuf, nvds_msgapi_send_cb_t send_callback, void *user_ptr)
 Sends message asynchronously over a connection. More...
NvDsMsgApiErrorType nvds_msgapi_subscribe (NvDsMsgApiHandle h_ptr, char **topics, int num_topics, nvds_msgapi_subscribe_request_cb_t cb, void *user_ctx)
 Subscribe to a remote entity for receiving messages on a particular topic(s) More...
void nvds_msgapi_do_work (NvDsMsgApiHandle h_ptr)
 Calls into the adapter to allow for execution of undnerlying protocol logic. More...
NvDsMsgApiErrorType nvds_msgapi_disconnect (NvDsMsgApiHandle h_ptr)
 Terminates a connection. More...
char * nvds_msgapi_getversion (void)
 Gets the version number of the messaging API interface supported by the protocol adapter. More...