DataHubConnector Methods

Table of Contents

DataHubConnector - creates a DataHubConnector object.

~DataHubConnector - destroys a DataHubConnector object.

activeHeartbeatTimers - determines if both heartbeat timers are active.

addPointValue - adds a specified amount to a Cascade DataHub point value.

appendPointValue - appends a string to a Cascade DataHub point.

cancelHeartbeatTimers - cancels the heartbeat and timeout timers.

cancelReconnectionTimer - stops the delay timer for reconnection attempts.

closeConnection - closes the connection to the Cascade DataHub.

createPoint - creates a Cascade DataHub point.

dividePointValue - divides the value of the named point by the specified value.

escapedString - prepares a string for use with writeCommand (Java and C# only).

getCnxState - retrieves the operational state of the connector object.

getCnxStateString - retrieves a string corresponding to the operational state.

getCnxSubStateString - provides detailed information on the connection state (C++ only).

getDefaultDomain - returns the current default domain.

getErrString - retrieves the last error string (C++ only).

getHeartbeat - retrieves the heartbeat timer period.

getHostName - retrieves the host name connection parameter.

getPort - retrieves the port connection parameter.

getReconnectionDelay - retrieves the delay time between reconnection attempts.

getServiceName - retrieves the port service name connection parameter (C++ only).

getTimeout - retrieves the timeout timer period.

initializePointCache - initializes local point cache usage.

isConnected - indicates whether a connection has been established.

isConnecting - indicates whether a connection attempt is in progress.

lookupPoint - accesses a point from the point cache.

multiplyPointValue - multiplies a Cascade DataHub point value by a specified amount.

openConnection - attempts to establish a connection to the Cascade DataHub.

readPoint - gets the value of a Cascade DataHub point.

registerDomain - registers to receive updates from domain points.

registerPoint - registers to receive updates from a Cascade DataHub point.

retryConnection - opens a new connection to the Cascade DataHub (C++ only).

sendBinaryPointMessages - formats data in binary mode (C++ only).

sendLispMessage - sends a message to the Cascade DataHub (C++ only).

sendLogin - transmits the user name and password.

setConnectionParms - sets the connection parameters.

setDefaultDomain - sets the default domain.

setHeartbeatTimes - sets the period of the heartbeat timers.

setPointLock - sets the lock attributes of a Cascade DataHub point.

setPointSecurity - sets the security attributes of a Cascade DataHub point.

setReconnectionDelay - sets the delay time between reconnection attempts.

setUsername - stores a user name and password for this connection.

shutdown - prepares for an application shutdown or disconnect (Java and C# only).

startHeartbeatTimers - starts the heartbeat and timeout timers.

startReconnectionTimer - starts the delay timer for reconnection attempts.

unregisterPoint - stops receiving updates from a Cascade DataHub point.

writeCommand - sends a command to the Cascade DataHub (Java and C# only).

writePoint - writes a new value to a Cascade DataHub point.