| Cogent C API and Utilities : Version 6.4 | ||
|---|---|---|
 | Cascade DataHub Functions |  |
| Cogent C API and Utilities : Version 6.4 | ||
|---|---|---|
| | Cascade DataHub Functions | |
#include <cogent.h>
ST_STATUS DH_SetReceiveFormat(IP_Task* myself, IP_Msg* hmsg, char* domain, int flag, ER_hLIST elist );
The task handle associated with this task. This should always be the return value from IP_NserveInit.
A handle to a previously allocated message structure (using IP_MsgCreate) providing enough buffer space to handle the inter-process communication associated with the DataHub transaction.
The name of the Cascade DataHub domain.
One of these:
| PT_FMT_ASCII | Constructs a humanly readable ASCII string (the default). |
| PT_FMT_BINARY | Encodes data as a raw binary representation, efficient for parsing. |
| PT_FMT_HEX | Encodes data as ASCII encoded hex. This is not a valuable format since it is more difficult to parse and less space efficient than binary, and it is more difficult for humans to read than regular ASCII. |
A return value containing error information. This is unimplemented in this version, and should be NULL.
This function sets a global variable that determines whether transmissions from the Cascade DataHub to a client will be in binary or ASCII format. It instructs the DataHub to transmit all messages to the custom client using the specified format. This call will fail with ST_NO_TASK if the custom client has never successfully called one of DH_RegisterPoint, DH_RegisterExistingPoint or DH_RegisterAllPoints. This is because the Cascade DataHub does not maintain internal state information for clients that are not registered to receive point exceptions.
| |  | |
| DH_SetLock, DH_SetSecurity |  | DH_SetTransmitFormat |
Copyright © 1995-2010 by Cogent Real-Time Systems, Inc. All rights reserved.