Integratec API Platform
C

The C wrapper provides access to the API when using the C or C++ language. More...

Typedefs

typedef void OPAPIStatusCallback(OPAPIHandle sender, wchar_t *id, wchar_t *status)
 Callback function that receives status updates for in progress requests. More...
 

Functions

OPAPI OPBOOL opGetApiVersion (wchar_t **version, wchar_t **errorMsg)
 Returns the API version. More...
 
OPAPI OPBOOL opGenerateKeyPair (wchar_t *path, wchar_t *name, wchar_t **errorMsg)
 Generates a public and private encryption key pair. More...
 
OPAPI OPBOOL opClientConnectionOpen (wchar_t *ip, int32_t port, OPAPIStatusCallback statusCallback, OPAPIHandle *connection, wchar_t **brokerId, wchar_t **errorMsg)
 Opens and registers a client connection to a master. More...
 
OPAPI void opClientConnectionClose (OPAPIHandle connection)
 Closes a client connection. More...
 
OPAPI OPBOOL opClientConnectionSendRequest (OPAPIHandle connection, wchar_t *serviceId, wchar_t *request, wchar_t **requestId, wchar_t **errorMsg)
 Sends an asynchronous request. More...
 
OPAPI OPBOOL opClientConnectionReceiveReply (OPAPIHandle connection, wchar_t *requestId, int32_t timeoutMs, wchar_t **reply, wchar_t **errorMsg)
 Receives a reply to an asynchronous request. More...
 
OPAPI OPBOOL opClientConnectionDeleteRequest (OPAPIHandle connection, wchar_t *requestId, wchar_t **errorMsg)
 Deletes the record of a request. More...
 
OPAPI OPBOOL opClientConnectionSendRecvDelete (OPAPIHandle connection, wchar_t *serviceId, wchar_t *request, int32_t timeoutMs, wchar_t **reply, wchar_t **errorMsg)
 Sends a request and waits for the reply. More...
 
OPAPI OPBOOL opClientConnectionGetCall (OPAPIHandle connection, void **call, wchar_t **errorMsg)
 Gets an IDispatch interface that can be used to make Remote Procedure Calls. More...
 
OPAPI OPBOOL opControlConnectionOpen (wchar_t *ip, int32_t port, OPAPIHandle *control, wchar_t **errorMsg)
 Opens a control connection to a control hub. More...
 
OPAPI void opControlConnectionClose (OPAPIHandle control)
 Closes a control connection. More...
 
OPAPI OPBOOL opControlConnectionStart (OPAPIHandle control, wchar_t **errorMsg)
 Sends a signal to the control hub to start registered processes on each control node. More...
 
OPAPI OPBOOL opControlConnectionStop (OPAPIHandle control, wchar_t **errorMsg)
 Sends a signal to the control hub to stop registered processes on each control node. More...
 

Detailed Description

The C wrapper provides access to the API when using the C or C++ language.

This has been tested with Visual Studio 2015, but may also work with other compilers.