TipcConnClient Members

Public Instance Properties

Arch	Returns the architecture this client is running on.
AutoFlushSize	Gets/Sets the number of bytes buffered before the outbound queue is automatically flushed, or 0 if this behavior is disabled, in which case manual calls to flush are required to empty the outbound queue.
BlockMode	Gets/Sets the blocking mode. This is true (i.e., block) by default.
DefaultControlCb	Gets the default callback for CONTROL messages.
DefaultGmdFailureCb	Gets the default callback for GMD_FAILURE messages.
GmdNumPending	Gets the number of GMD messages that have been sent but not ack'd or deleted.
LocalPid	Gets/Sets the local pid for this connection.
Node	Gets the node (host) name for the remote machine.
NumQueued	Get the number of messages queued for reading.
Pid	Get the pid (process id) for the remote machine.
Properties	Get this connection's properties.
QueueSize	Gets the size of the read queue, in bytes.
ReadBufferSize	Gets the total number of bytes in the connection's read buffer.
TrafficBytesRecv	Gets the total number of bytes received on this connection Note: The result is truncated to 31 bits, and may contain an incorrect sign bit on some older clients. New clients should use TrafficBytesRecv8.
TrafficBytesRecv8	Gets the total number of bytes received on this connection
TrafficBytesSent	Gets the total number of bytes written to the write buffer on a connection. This number usually is the same as the total number of bytes actually sent on the connection, but sometimes the retrieved number is larger than the number of bytes sent when the write buffer is not frequently flushed. Note: The result is truncated to 31 bits, and may contain an incorrect sign bit on some older clients. New clients should use TrafficBytesSent8.
TrafficBytesSent8	Gets the total number of bytes written to the write buffer on a connection. This number usually is the same as the total number of bytes actually sent on the connection, but sometimes the retrieved number is larger than the number of bytes sent when the write buffer is not frequently flushed.
TrafficMsgsRecv	Gets the total number of messages received on this connection Note: The result is truncated to 31 bits, and may contain an incorrect sign bit on some older clients. New clients should use TrafficMsgsRecv8.
TrafficMsgsRecv8	Gets the total number of messages received on this connection
TrafficMsgsSent	Gets the total number of messages written to the write buffer on a connection. This number usually is the same as the total number of messages actually sent on the connection, but sometimes the retrieved number is larger than the number of messages sent when the write buffer is not frequently flushed. Note: The result is truncated to 31 bits, and may contain an incorrect sign bit on some older clients. New clients should use TrafficMsgsSent8.
TrafficMsgsSent8	Gets the total number of messages written to the write buffer on a connection. This number usually is the same as the total number of messages actually sent on the connection, but sometimes the retrieved number is larger than the number of messages sent when the write buffer is not frequently flushed.
UniqueSubject	Retrieve the unique subject of the peer we are connected to. The unique subject is, as the name suggests, a name unique to a process. This method returns the unique subject for the process at the other end of the connection.
User	Get user id of client process.
WriteBufferSize	Gets the total number of bytes in the connection's write buffer.

Public Instance Methods

addDefaultCb	Overloaded. Adds a default callback class with default priority. This callback is called if there are no other callbacks defined for a given message type.
addErrorCb	Overloaded. Adds an error callback class with default priority. The error callback is called when certian types of errors occur.
addProcessCb	Overloaded. Adds a process callback class with default priority. The process callback is called when process is called with a message matching the provided message type. The message type parameter may be null, which means that all message types will be passed to this method. However, if you use the null form, you must cast the null to TipcMt, or the compiler will be unable to resolve which version of this method you wish: this one, or the version that takes a mt number parameter. To avoid the cast. you can use the mt number version instead, and pass a 0 as the mt number.
addQueueCb	Overloaded. Adds a queue callback class for message type with default priority. The queue callback is called when a message is inserted or removed from the connection's queue. The queue callback is called when a message is inserted or removed and message has a callback registered with a message matching the provided message type. The message type parameter may be null, which means that all message types will be passed to this method. However, if you use the null form, you must cast the null to TipcMt, or the compiler will be unable to resolve which version of this method you wish: this one, or the version that takes a mt number parameter. To avoid the cast. you can use the mt number version instead, and pass a 0 as the mt number.
addReadCb	Overloaded. Adds a read callback class with default priority. The read callback is called when a message is read. It is called before the message is returned by the next method.
addWriteBufferChangeCb	Overloaded. Adds a write buffer change callback class with default priority. The write buffer callbacks are called when the write buffer is either flushed or written to THROUGH the message interface ONLY.
addWriteCb	Overloaded. Adds a write callback class with default priority. The write callback is called when a message is written. It is called when the message is actually sent, not when the send method is called.
check	Checks for traffic on the connection. If `check_mode` is IO_CHECK_READ, this method will return `true` if there is data available to be read. If IO_CHECK_WRITE, `true` will be returned if data can be written to the connection without blocking. If the `timeout_read` option is 0.0, this method will block for up to timeout seconds. Otherwise, this method will return immediately. Note: this method is also called by the next and search methods. This method is rarely used by end-user programs.
destroy	Destroys the connection.
Equals (inherited from Object)	Determines whether the specified Object is equal to the current Object.
flush	Flushed queued data to the connection. This ensures all buffered data is written immediately. The outbound queue will be flushed automatically when it reaches a set size, set by AutoFlushSize property, unless the auto flush size is set to 0, in which case explicit calls to this method are required.
getGmdDir	Gets the directory where GMD files are written.
GetHashCode (inherited from Object)	Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
getOption	Convenience method to get an option by name. Typically one would use the getOption method. This method is available for when an option needs to be different for each connection.
getOptionBool	Convenience method to get an option's `boolean` value. Typically one would use the getOptionBool method. This method is available for when an option needs to be different for each connection.
getOptionDouble	Convenience method to get an option's `double` value. Typically one would use the getOptionDouble method. This method is available for when an option needs to be different for each connection.
getOptionInt	Convenience method to get an option's `int` value. Typically one would use the getOptionInt method. This method is available for when an option needs to be different for each connection.
getOptionStr	Convenience method to get an option's `String` value. Typically one would use the getOptionStr method. This method is available for when an option needs to be different for each connection.
getTimeout	Get a timeout value. There are several timeout properties associated with a connection: TIMEOUT_READ, TIMEOUT_WRITE, TIMEOUT_KEEP_ALIVE, and TIMEOUT_DELIVERY, all of which are used to check for network failures. This method allows the values of these timeout properties to be inspected. All timeout values are in seconds. The TIMEOUT_READ property specifies the length of time that no data is read on the connection before a keep alive message is exchanged with remote end. If this is set to 0.0, the connection will block forever waiting for data to arrive and no keep alives will be generated. The TIMEOUT_KEEP_ALIVE property is the length of time the client will wait for a reply to a keep alive request. If this timeout expires, the error callback will be called with a timeout error code. The TIMEOUT_DELIVERY property is the length of time the client will wait for an ack to arrive for amessage sent with GMD. If this expires, a GMD_FAILURE message will be generated and processed by the client. The TIMEOUT_WRITE property is not implemented in this release.
GetType (inherited from Object)	Gets the Type of the current instance.
gmdFileDelete	Removes GMD files from disk.
gmdMsgAck	Acknowledges a message sent with GMD.
gmdMsgDelete	Delete a message from the local spool.
gmdMsgResend	Resends a message previously sent with GMD. This should only be used within a `GMD_FAILURE` callback.
gmdResend	Resends all spooled messages. For Rtserver connections, method will be called automatically when a connection is re-made, so there is no need to call it yourself. Caution: this method should only be used when a connection is first created. This method resends messages with GMD, but does not explicitly flush the messags. You may need to invoke flush.
insert	Insert a message into the inbound queue. For inserting messages to be processed as though they were received from the socket, or re-inserting messages that have been removed, but cannot be processed immediately.
keepAlive	Send a keep alive message to the other end and wait synchronously for a response. The amount of time to wait is set by the `KEEP_ALIVE` timeout. If the keep alive timeout expires before the other end of the connection responds, this method will fail.
loadOptionsStream	Loads an option file from an InputStream. Loaded options override existing options with the same key. Typically one would use the loadOptionsStream method. This method is available for when an option needs to be different for each connection.
lookupDefaultCb	Looks up callback for default message processing.
lookupErrorCb	Looks up callback for error processing.
lookupProcessCb	Overloaded. Looks up callback for process message processing.
lookupQueueCb	Overloaded. Looks up callback for queued message processing.
lookupReadCb	Overloaded. Looks up callback for message reading.
lookupWriteBufferChangeCb	Looks up callback for write buffer change processing.
lookupWriteCb	Overloaded. Looks up callback for message writing.
mainLoop	Loop for the specified timeout, reading and processing messages from the connection. This is a convenience method, which employs a loop doing next, process, and ack. To specify an infinite loop, pass TIMEOUT_FOREVER.
makeSubjectAbsolute	If the subject isn't absolute (doesn't start with "/"), tack on the default subject prefix, if is exists. If the prefix isn't set to anything, it simply returns the original name untouched.
next	Get messages from the inbound queue. If no messages are waiting in the inbound queue this method will block waiting for a message to arrive from the connection.
process	Process a message by calling the process callbacks for that mesage's type. A callback may be setup to process mesages as they arrive. This method calls those callbacks.
read	Read traffic. This is functionally equivalent to calling check with IO_CHECK_READ mode. The background reader thread will fill the inbound message queue with any messages that arrive during the timeout period.
readFully	Overloaded.
removeDefaultCb	Remove a default callback class.
removeErrorCb	Remove a error callback class.
removeProcessCb	Remove a process callback class.
removeQueueCb	Remove a queue callback class.
removeReadCb	Remove a read callback class.
removeTrafficCb	Remove a traffic callback class.
removeWriteBufferChangeCb	Remove a write buffer change callback class.
removeWriteCb	Remove a write callback class.
search	Find a message in the inbound queue, using a user-provided matching method. This method scans the inbound queue, calling a user-provided method that is handed each message in turn to see if it matches the desired criteria. If no appropriate messages are found in the inbound queue, this method will wait until the desired message arrives from the connection. The message, if found, will be removed from the inbound queue.
searchType	Overloaded. Find a message in the inbound queue matching a specific message type. This method scans the inbound queue, checking for messages matching the desired type. If no appropriate messages are found in the inbound queue, this method will wait until the desired message arrives from the connection. The message, if found, will be removed from the inbound queue.
searchTypeNoFlush	Searches for a message of a particular type without flushing the outbound queue first.
send	Send a message. This method actually queues the data for later transmission. It is not actually sent until flush is called, either by the user directly, or by the auto-flush mechanism, based on the buffer size.
sendRpc	Send a message and synchronously wait for the result. The expected result message will have a message type with a number one greater than the sent message type. If a message with the expected type is not received before the timeout expires, this method will fail.
setOption	Convenience method to set an option by name. Typically one would use the setOption method. This method is available for when an option needs to be different for each connection.
setTimeout	Set a timeout value. See the getTimeout method for an explanation of connection timeout properties.
ToString (inherited from Object)	Returns a String that represents the current Object.
write	Overloaded.

Public Instance Events

TipcErrorEvent	Occurs when an error occurs on a connection. Connection Error events are raised when an unrecoverable error occurs. These errors include socket problems and network failures such as: A read timeout has occured and the keep-alive then failed. A write timeout has occured. A read operation on the connection's socket failed. The most common cause of this error is that the process at the other end of the connection has destroyed its connection, which closed the socket. A write operation on the connection's socket failed. The most common cause of this error is that the process at the other end of the connection has destroyed its connection, which closed the socket.
TipcMsgEvent	Occurs when a message is processed. Connection process events are raised while processing a message. This callback type is the most frequently used. A process delegate method is called for every of message received. When any message of any type is processed by calling process or mainLoop, the process callback is called.
TipcQueueEvent	Occurs with message queue events. Connection queue events are raised when a message is inserted into or deleted from a connection's message queue. Queue events are useful for watching the messages that have been read in from a connection's socket and inserted into the message queue, but not yet processed.
TipcReadEvent	Occurs when a message is read from a connection. Connection read events are raised when an incoming message is read from a connection's socket into the read buffer and first unpacked into a message. Read events are most commonly used for writing incoming messages to message files.
TipcWriteBufferChangeEvent	Occurs when the write buffer is accessed. Write buffer change events are raised when data is either flushed from the write buffer or written into write buffer THROUGH the message interface (i.e. with send(msg)) ONLY.
TipcWriteEvent	Occurs when a message is written to a connection. Connection write events are raised when an outgoing message is sent to a connection (that is, copied to a connection's write buffer). Write events are most commonly used for writing outgoing messages to message files.

Protected Instance Methods

Finalize (inherited from Object)	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)	Creates a shallow copy of the current Object.

TipcConnClient Members

Public Instance Properties

Public Instance Methods

Public Instance Events

Protected Instance Methods

See Also