The methods of the TipcSrv class are listed below. For a complete list of TipcSrv class members, see the TipcSrv Members topic.
Public Instance Methods
 addCreateCb | Overloaded. Adds a callback for the RTserver connection creation with default priority. |
| addDefaultCb (inherited from TipcConnClient) | 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. |
| addDestroyCb | Overloaded. Adds a callback for the RTserver destruction with default priority. |
| addErrorCb (inherited from TipcConnClient) | Overloaded. Adds an error callback class with default priority. The error callback is called when certian types of errors occur. |
| addProcessCb | Overloaded. public implementation |
| addQueueCb (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 |
Check for traffic on the connection. If mode is
IO_CHECK_READ, this
method will return true if there is data
available to be read. If ss.server_read_timeout option is
0.0, this method will block for up the specified
timeout. Otherwise, this method will return immediately.
|
| create | Overloaded.
Creates the RTserver connection using the default
connection type CONN_FULL
and with the specified credentials.
Connects to and handshakes with the RTserver process.
Does not attempt to auto-start an RTserver if one cannot
be contacted. Instead, it will loop through the list of
servers specified with ss.server_names option
until a connection is made. This process is synchronous.
and all other threads that attempt to use the connection
will block until this succeeds, or fails completely.
|
| destroy | Overloaded. Destroys (closes) the RTServer connection. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| flush | Flushes queue data to the connection. This ensures that all buffered data is written immediately. This outbound queue will be flushed automatically when it reaches a set size, set by the ss.server_auto_flush_size option. |
| getGmdDir (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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. |
| getSubjectLb | find out if a subject is using load balancing. |
| getSubjectSubscribe | find out if a subject is subscribed to. |
| getTimeout (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | Removes GMD files from disk. |
| gmdMsgAck (inherited from TipcConnClient) | Acknowledges a message sent with GMD. |
| gmdMsgDelete (inherited from TipcConnClient) | Delete a message from the local spool. |
| gmdMsgResend (inherited from TipcConnClient) |
Resends a message previously sent with GMD. This should
only be used within a GMD_FAILURE callback.
|
| gmdMsgServerDelete | Deletes a GMD message from RTserver's spool. Use gmdMsgDelete to delete a message from the local spool. This method fails silently if the msg doesn't exist. |
| gmdMsgStatus | Gets the status of the gmd message. |
| gmdResend (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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. |
| logAddMt | Overloaded. Adds a message type for message logging. Messages will logged to the file specified by the options: ss.log_out_data, ss.log_in_data, ss_log_out_status. ss.log_in_status, ss.log_out_internal, and ss.log_in_internal And based upon the logging type. |
| logRemoveMt | Overloaded. Removes a message type from message logging. |
| lookupCreateCb | Looks up a callback for the RTserver connection creation |
| lookupDefaultCb (inherited from TipcConnClient) | Looks up callback for default message processing. |
| lookupDestroyCb | Looks up a callback for the RTserver destruction. |
| lookupErrorCb (inherited from TipcConnClient) | Looks up callback for error processing. |
| lookupProcessCb | Overloaded. public implementation |
| lookupQueueCb (inherited from TipcConnClient) | Overloaded. Looks up callback for queued message processing. |
| lookupReadCb (inherited from TipcConnClient) | Overloaded. Looks up callback for message reading. |
| lookupWriteBufferChangeCb (inherited from TipcConnClient) | Looks up callback for write buffer change processing. |
| lookupWriteCb (inherited from TipcConnClient) | Overloaded. Looks up callback for message writing. |
| mainLoop (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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 then this method will wait for the specified timeout for a message to arrive. |
| process | Process a message by calling the process callback for that message's type. A callback may be setup to process messages as they arrive. This method calls those callbacks. |
| processCacheRequest | set Caching Interface |
| read (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | Overloaded. |
| removeCreateCb | Removes a callback for the RTserver connection creation. |
| removeDefaultCb (inherited from TipcConnClient) | Remove a default callback class. |
| removeDestroyCb | Removes a callback for the RTserver destruction. |
| removeErrorCb (inherited from TipcConnClient) | Remove a error callback class. |
| removeProcessCb | Removes a callback for the RTserver connection. |
| removeQueueCb (inherited from TipcConnClient) | Remove a queue callback class. |
| removeReadCb (inherited from TipcConnClient) | Remove a read callback class. |
| removeTrafficCb (inherited from TipcConnClient) | Remove a traffic callback class. |
| removeWriteBufferChangeCb (inherited from TipcConnClient) | Remove a write buffer change callback class. |
| removeWriteCb (inherited from TipcConnClient) | Remove a write callback class. |
| search (inherited from TipcConnClient) | 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 (inherited from TipcConnClient) | 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. The auto-flush mechanism is regulated by the ss.server_auto_flush_size option. |
| sendRpc | Send a RPC message. |
| setOption (inherited from TipcConnClient) | 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. |
| setSubjectSubscribe | set the subscribe status on a subject. |
| setSubjectSubscribeEx | Extended Subscribe/Unsubscribe |
| setSubjectSubscribeLb | set the subscribe and load balancing status on a subject. |
| setTimeout (inherited from TipcConnClient) | Set a timeout value. See the getTimeout method for an explanation of connection timeout properties. |
| setUsernamePassword | Sets the username and password for the RTclient when connecting to an RTserver with the Basic Security Driver installed. The password is immediately encrypted and is never sent in plain text to the RTserver. |
| subjectGmdInit | initializes GMD. This has not yet been implemented. |
| subjectLbInit | initializes load balancing. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
| write (inherited from TipcConnClient) | Overloaded. |
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. |
Protected Internal Instance Methods
| handleOptionPoll | protected implemenation of TipcConnClient.handleOptionPoll |
See Also
TipcSrv Class | TIBCO.SMARTSOCKETS Namespace
Copyright © TIBCO Software Inc. All rights reserved