tpcall

Reply tpcall(String svc,
             TypedBuffer data,
             int flags)
             throws TPException,
                    TPReplyException

Sends a request and synchronously awaits for the reply. A call to tpcall is the same as a deferred tpacall immediately followed by tpgetrply. tpcall sends a request to the service named by svc. The request is sent out at the priority defined for svc unless overridden by a previous call to tpsprio. The type and sub-type of data must match one of the types and sub-types recognized by svc.

Parameters:

svc - The name of the Tuxedo service

data - Pointer to the data buffer; null specifies no data sent

flags - The following is a list of valid flags:

• TPNOTRAN: If the caller is in transaction mode and this flag is set, then when svc is invoked, it is not performed on behalf of the caller's transaction. Note that svc may still be invoked in transaction mode but it will not be the same transaction: a svc may have as a configuration attribute that it is automatically invoked in transaction mode. A caller in transaction mode that sets this flag is still subject to the transaction timeout (and no other). If a service fails that was invoked with this flag, the caller's transaction is not affected.
• TPNOBLOCK: The request is not sent if a blocking condition exists. For example: the internal buffers into which the message is transferred are full. This flag applies only to the send portion of tpcall - the function may block when waiting for the reply. When TPNOBLOCK is not specified and a blocking condition exists, the caller blocks until the condition subsides or a timeout occurs (either transaction or blocking timeout).
• TPNOTIME: Specifies that the caller is willing to block indefinitely and is immune to blocking timeouts. An exception is when the caller is in transaction mode. If the call is in transaction, this flag has no effect and transaction timeouts may occur.

Returns:

Upon success tpcall returns a reply object that contains the reply data from the service and the service return status. You should always check the return status of the reply object to determine if the service returned successfully.

Throws:

TPException - Upon failure tpcall sets tperrno in TPException to one of the following values. Unless otherwise noted, failure does not affect the caller's transaction, if one exists.

• TPEINVAL: Invalid arguments were given. For example: svc is null or flags are invalid.
• TPENOENT: Cannot send to svc because it does not exist, it is a conversational service, or the name provided begins with "." - a dot.
• TPEITYPE: The type and sub-type of data is not one of the allowed types and sub-types that svc accepts.
• TPEOTYPE: The type and sub-type of the reply are not known to the caller. If the service request was made on behalf of the caller's current transaction, then the transaction is marked abort-only since the reply is discarded.
• TPETRAN: svc belongs to a server that does not support transactions and TPNOTRAN was not set.
• TPETIME: A timeout occurred. If the caller is in transaction mode, then a transaction timeout occurred and the transaction is marked abort-only. Otherwise, a blocking timeout occurred and neither TPNOBLOCK nor TPNOTIME was specified. If a transaction timeout occurred, then with one exception, any attempts to send new requests or receive outstanding replies fail with TPETIME until the transaction has been aborted. The exception is a request that does not block, expects no reply, and is not sent on behalf of the caller's transaction - that is, tpacall with TPNOTRAN, TPNOBLOCK, and TPNOREPLY set.
• TPEBLOCK: A blocking condition was found on the send call and TPNOBLOCK was specified.
• TPEPROTO: tpcall was called improperly.
• TPESYSTEM: A BEA Tuxedo system error has occurred. The exact nature of the error is written to a log file.
• TPEOS: An operating system error has occurred. If a message queue on a remote location is filled, TPEOS may be returned even if tpcall returned successfully.

TPReplyException - If there was a service failure (TPESVCFAIL or TPSVCERROR), the exception will also have the reply data from the service.

tpenqueue

byte[] tpenqueue(String qspace,
                 String qname,
                 EnqueueRequest ctl,
                 TypedBuffer data,
                 int flags)
                 throws TPException

Stores a message on the queue named by qname in the qspace queue space. A queue space is a collection of queues, one of which must be qname.

When the message is intended for a BEA Tuxedo system server, the qname matches the name of a service provided by the server. The system provided server, TMQFORWARD(5), provides a default mechanism for dequeuing messages from the queue and forwarding them to servers that provide a service matching the queue name. If the originator expects a reply, then the reply to the forwarded service request is stored on the originator's queue, unless otherwise specified. The originator will dequeue the reply message at a subsequent time. Queues can also be used for a reliable message transfer mechanism between any pair of BEA Tuxedo system processes (clients and/or servers). In this case, the queue name does not match a service name but some agreed upon name for transferring the message.

If data is non-null, it must point to an object that implements the TypedBuffer interface. If data is null a message is queued with no data portion.

The message is queued at the priority defined for qspace unless overridden by a previous call to tpsprio().

If the caller is within a transaction and the TPNOTRAN flag is not set, the message is queued in transaction mode. This has the effect that if tpenqueue() returns successfully and the caller's transaction is committed successfully, then the message is guaranteed to be available subsequent to the transaction completing. If the caller's transaction is rolled back either explicitly or as the result of a transaction timeout or some communication error, then the message will be removed from the queue (that is, the placing of the message on the queue is also rolled back). It is not possible to enqueue then dequeue the same message within the same transaction.

The message is not queued in transaction mode if either the caller is not in transaction mode, or the TPNOTRAN flag is set. Once tpenqueue() returns successfully, the submitted message is guaranteed to be in the queue. When not in transaction mode, if a communication error or a timeout occurs, the application will not know whether or not the message was successfully stored on the queue.

The order in which messages are placed on the queue is controlled by the application via ctl object as described in the EnqueueRequest manual page; the default queue ordering is set when the queue is created.

Additional information about queuing the message can be specified via ctl object. This information includes values to override the default queue ordering placing the message at the top of the queue or before an enqueued message; an absolute or relative time after which a queued message is made available; an absolute or relative time when a message expires and is removed from the queue; the quality of service for delivering the message; the quality of service that any replies to the message should use; a correlation identifier that aids in correlating a reply or failure message with the queued message; the name of a queue to which a reply should be enqueued; and the name of a queue to which any failure message should be enqueued. See the EnqueueRequest object for more information.

Parameters:

qspace - The name of the queue space to enqueue this message on

qname - The name of the queue within qspace to enqueue this message on

ctl - The EnqueueRequest object describing this enqueue operation

data - The data to be enqueued

flags - The following is a list of valid flags:

• TPNOTRAN If the caller is in transaction mode and this flag is set, the message is not queued within the caller's transaction. A caller in transaction mode that sets this flag is still subject to the transaction timeout (and no other) when queuing the message. If message queuing fails, the caller's transaction is not affected.
• TPNOBLOCK The message is not enqueued if a blocking condition exists. If this flag is set and a blocking condition exists such as the internal buffers into which the message is transferred are full, the call fails and tperrno in TPException is set to TPEBLOCK. If this flag is set and a blocking condition exists because the target queue is opened exclusively by another application, the call succeeds but the diagnostic field of the Enqueue object is set to QMESHARE. In the latter case, the other application, which is based on a BEA product other than the BEA Tuxedo system, opened the queue for exclusive read and/or write using the Queuing Services API (QSAPI).

  When TPNOBLOCK is not set and a blocking condition exists, the caller blocks until the condition subsides or a timeout occurs (either transaction or blocking timeout). If a timeout occurs, the call fails and tperrno in TPException is set to TPETIME.

• TPNOTIME Setting this flag signifies that the caller is willing to block indefinitely and wants to be immune to blocking timeouts. Transaction timeouts may still occur.

Returns:

The message id of the enqueued message

Throws:

TPException - Upon failure, tpenqueue() sets tperrno in TPException to one of the following values (unless otherwise noted, failure does not affect the callers transaction, if one exists)

• TPEINVAL Invalid arguments were given (for example, qspace is null or flags are invalid).
• TPENOENT Cannot access the qspace because it is not available (that is, the associated TMQUEUE(5) server is not available), or cannot start a global transaction due to the lack of entries in the Global Transaction Table (GTT).
• TPETIME A timeout occurred. If the caller is in transaction mode, a transaction timeout occurred and the transaction is to be aborted; otherwise, a blocking timeout occurred and neither TPNOBLOCK nor TPNOTIME was specified. If a transaction timeout occurred, any attempts to enqueue new messages will fail with TPETIME until the transaction has been aborted.
• TPEBLOCK A blocking condition exists and TPNOBLOCK was specified.
• TPEPROTO tpenqueue() was called improperly.
• TPESYSTEM A BEA Tuxedo system error has occurred. The exact nature of the error is written to a log file.
• TPEOS An operating system error has occurred.
• TPEDIAGNOSTIC One of the following values is available in the diagnostic field of the execption:
  • QMEINVAL An invalid flag value was specified.
  • QMEBADRMID An invalid resource manager identifier was specified.
  • QMENOTOPEN The resource manager is not currently open.
  • QMETRAN The call was not in transaction mode or was made with the TPNOTRAN flag set and an error occurred trying to start a transaction in which to enqueue the message. This diagnostic is not returned by queue managers from BEA Tuxedo Release 7.1 or later.
  • QMEBADMSGID An invalid message identifier was specified.
  • QMESYSTEM A system error occurred. The exact nature of the error is written to a log file.
  • QMEOS An operating system error occurred.
  • QMEABORTED The operation was aborted. When executed within a global transaction, the global transaction has been marked rollback-only. Otherwise, the queue manager aborted the operation.
  • QMEPROTO An enqueue was done when the transaction state was not active.
  • QMEBADQUEUE An invalid or deleted queue name was specified.
  • QMENOSPACE Due to an insufficient resource, such as no space on the queue, the message with its required quality of service (persistent or non-persistent storage) was not enqueued. QMENOSPACE is returned when any of the following configured resources is exceeded: (1) the amount of disk (persistent) space allotted to the queue space, (2) the amount of memory (non-persistent) space allotted to the queue space, (3) the maximum number of simultaneously active transactions allowed for the queue space, (4) the maximum number of messages that the queue space can contain at any one time, (5) the maximum number of concurrent actions that the Queuing Services component can handle, or (6) the maximum number of authenticated users that may concurrently use the Queuing Services component.
  • QMERELEASE An attempt was made to enqueue a message to a queue manager that is from a version of the BEA Tuxedo system that does not support a newer feature.
  • QMESHARE When enqueuing a message from a specified queue, the specified queue is opened exclusively by another application. The other application is one based on a BEA product other than the BEA Tuxedo system that opened the queue for exclusive read and/or write using the Queuing Services API (QSAPI).

tpdequeue

DequeueReply tpdequeue(String qspace,
                       String qname,
                       byte[] msgid,
                       byte[] corrid,
                       boolean doWait,
                       boolean doPeek,
                       int flags)
                       throws TPException

Removes a message for processing from the queue named by qname in the qspace queue space.

By default, the message at the top of the queue is dequeued. The order of messages on the queue is defined when the queue is created. The application can request a particular message for dequeuing by specifying its message identifier or correlation identifier. There are also parameters used to indicate that the application wants to wait for a message, in the case when a message is not currently available. It is possible to use tpdequeue to look at a message without removing it from the queue or changing its relative position on the queue.

The message is dequeued in transaction mode if the caller is in transaction mode and the TPNOTRAN flag is not set. This has the effect that if tpdequeue() returns successfully and the caller's transaction is committed successfully, then the message is removed from the queue. If the caller's transaction is rolled back either explicitly or as the result of a transaction timeout or some communication error, then the message will be left on the queue (that is, the removal of the message from the queue is also rolled back). It is not possible to enqueue and dequeue the same message within the same transaction.

The message is not dequeued in transaction mode if either the caller is not in transaction mode, or the TPNOTRAN flag is set. When not in transaction mode, if a communication error or a timeout occurs, the application will not know whether or not the message was successfully dequeued and the message may be lost.

Parameters:

qspace - The name of the queue space to enqueue this message on

qname - The name of the queue within qspace to enqueue this message on

msgid - If non-null it requests that the message with this identifier be dequeued. Note that a message identifier changes if the message has moved from one queue to another

corrid - If non-null it requests that the message with this correlation id be dequeued. The correlation identifier is specified by the application when enqueuing the message with tpenqueue

doWait - If true it indicates that an error should not be returned if the queue is empty. Instead the process should wait until a message is available. If doWait is true and msgid or corrid is not null, it indicates that an error should not be returned if no message with the specified message identifier or correlation identifier is present in the queue. Instead, the process should wait until until a message meeting the criteria is available. The process is still subject to the caller's transaction timeout, or, when not in transaction mode, the process is subject to the timeout specified on the TMQUEUE process by the -t option.

doPeek - If this is true, then the specified message is read but not removed from the queue. This flag implies the TPNOTRAN flag has been set for the tpdequeue operation. That is, non-destructive dequeueing is non-transactional. Note that it is not possible to read messages enqueued or dequeued within a transaction before the transaction completes.

flags - The following is a list of valid flags:

• TPNOTRAN If the caller is in transaction mode and this flag is set, the message is not dequeued within the caller's transaction. A caller in transaction mode that sets this flag is still subject to the transaction timeout (and no other) when dequeuing the message. If message dequeuing fails, the caller's transaction is not affected.
• TPNOBLOCK The message is not dequeued if a blocking condition exists. If this flag is set and a blocking condition exists such as the internal buffers into which the message is transferred are full, the call fails and TPException() is set to TPEBLOCK. If this flag is set and a blocking condition exists because the target queue is opened exclusively by another application, the call will throw an exception, and the diagnostic value in the TPException object is set to QMESHARE. In the latter case, the other application, which is based on a BEA product other than the BEA Tuxedo system, opened the queue for exclusive read and/or write using the Queuing Services API (QSAPI). When TPNOBLOCK is not set and a blocking condition exists, the caller blocks until the condition subsides or a timeout occurs (either transaction or blocking timeout). This blocking condition does not include blocking on the queue itself if doWait is true.
• TPNOTIME Setting this flag signifies that the caller is willing to block indefinitely and wants to be immune to blocking timeouts. Transaction timeouts may still occur.

Returns:

If tpdequeue() returns successfully, the application can retrieve additional information about the message using the DequeueReply object. The information may include the message identifier for the dequeued message; a correlation identifier that should accompany any reply or failure message so that the originator can correlate the message with the original request; the quality of service the message was delivered with, the quality of service any replies to the message should be delivered with; the name of a reply queue if a reply is desired; and the name of the failure queue on which the application can queue information regarding failure to dequeue the message. These are described in the DequeueReply object manual page.

Throws:

TPException - tperrno is set to one of the following values. (Unless otherwise noted, failure does not affect the caller's transaction, if one exists.)

• TPEINVAL Invalid arguments were given (for example, qname is null or flags are invalid).
• TPENOENT Cannot access the qspace because it is not available (that is, the associated TMQUEUE(5) server is not available), or cannot start a global transaction due to the lack of entries in the Global Transaction Table (GTT).
• TPEOTYPE The type and sub-type of the dequeued message are not known to the caller. When the call is made in transaction mode and this error occurs, the transaction is marked abort-only, and the message remains on the queue.
• TPETIME A timeout occurred. If the caller is in transaction mode, a transaction timeout occurred and the transaction is to be aborted; otherwise, a blocking timeout occurred and neither TPNOBLOCK nor TPNOTIME was specified. If a transaction timeout occurred, any attempts to dequeue new messages will fail with TPETIME until the transaction has been aborted.
• TPEBLOCK A blocking condition exists and TPNOBLOCK was specified.
• TPEPROTO tpdequeue() was called improperly. There is no effect on the queue or the transaction.
• TPESYSTEM A BEA Tuxedo system error has occurred. The exact nature of the error is written to a log file. There is no effect on the queue.
• TPEOS An operating system error has occurred. There is no effect on the queue.
• TPEDIAGNOSTIC The following diagnostic values may be returned in the exception:
  • QMEINVAL An invalid flag value was specified.
  • QMEBADRMID An invalid resource manager identifier was specified.
  • QMENOTOPEN The resource manager is not currently open.
  • QMETRAN The call was not in transaction mode or was made with the TPNOTRAN flag set and an error occurred trying to start a transaction in which to dequeue the message. This diagnostic is not returned by queue managers from BEA Tuxedo Release 7.1 or later.
  • QMEBADMSGID An invalid message identifier was specified for dequeuing.
  • QMESYSTEM A system error has occurred. The exact nature of the error is written to a log file.
  • QMEOS An operating system error has occurred.
  • QMEABORTED The operation was aborted. When executed within a global transaction, the global transaction has been marked rollback-only. Otherwise, the queue manager aborted the operation.
  • QMEPROTO A dequeue was done when the transaction state was not active.
  • QMEBADQUEUE An invalid or deleted queue name was specified.
  • QMENOMSG No message was available for dequeuing. Note that it is possible that the message exists on the queue and another application process has read the message from the queue. In this case, the message may be put back on the queue if that other process rolls back the transaction.
  • QMEINUSE When dequeuing a message by message identifier or correlation identifier, the specified message is in use by another transaction. Otherwise, all messages currently on the queue are in use by other transactions. This diagnostic is not returned by queue managers from BEA Tuxedo Release 7.1 or later.
  • QMESHARE When dequeuing a message from a specified queue, the specified queue is opened exclusively by another application. The other application is one based on a BEA product other than the BEA Tuxedo system that opened the queue for exclusive read and/or write using the Queuing Services API (QSAPI).
  • QMERELEASE An attempt was made to dequeue a message to a queue manager that is from a version of the BEA Tuxedo system that does not support a newer feature.

tpdequeue

DequeueReply tpdequeue(String qspace,
                       String qname,
                       int flags)
                       throws TPException

Removes a message for processing from the queue named by qname in the qspace queue space using the following parameters:

• msgid and corrid set to null.
• doWait and doPeek set to false.

Throws:

TPException

tpterm

void tpterm()
            throws TPException

Dissasociates an object from a Tuxedo session. No further ATMI calls can be made on this object after this tpterm has been called.

Throws:

TPException - if called in the wrong context

tpconnect

Conversation tpconnect(String svc,
                       TypedBuffer data,
                       int flags)
                       throws TPException