rdsession (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.wtc.jatmi.rdsession

```
public final class rdsession
extends java.lang.Object
```
Excluded in public API Reference.

This class implements the thread that reads messages from the network in a /T domains protocol session. These messages can either be responses to outstanding atmi requests, transactional control messages or new service requests.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.HashMap`	`conversationReplyObjects`
`private java.util.ArrayList`	`dispatchList`
`private int`	`dom_protocol`
`private boolean`	`is_term`
`private java.lang.String`	`local_domain_name`
`private static int`	`MAXCACHE`
`private long`	`myBlocktime`
`private gwatmi`	`myGwatmi`
`private InvokeSvc`	`myInvoker`
`private dsession`	`mySession`
`private java.util.Timer`	`myTimeService`
`private java.util.ArrayList`	`objectArrayList`
`private java.io.DataOutputStream`	`ostream`
`private java.util.HashMap`	`rplyObjMap`
`private java.util.HashMap`	`rplyXidObjMap`
`private java.util.ArrayList`	`tfmhList`
`private int`	`uid`
`private TuxXidRply`	`unknownXidRply`
`private BetaFeatures`	`useBetaFeatures`

Constructor Summary

Constructors
Constructor and Description
`rdsession(java.io.DataOutputStream dom_ostream, gwatmi ss, InvokeSvc invoke, int protocol, java.lang.String ldn, java.util.Timer timeService, TuxXidRply anXidRply, BetaFeatures betaFeatures)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add_rplyObj(SessionAcallDescriptor cd, ReplyQueue rplyObj, int blocktime, TpacallAsyncReply callBack)`
`void`	`add_rplyXidObj(Txid txid, TuxXidRply rplyXidObj, int blocktime)`
`private void`	`addlist(tfmh tmmsg, int opcode)`
`boolean`	`addRplyObjTimeout(SessionAcallDescriptor cd, int blocktime)`
`void`	`addTimeoutRequest(int giopReqId, int reqId, long blocktime)`
`private void`	`addXidlist(tfmh tmmsg)`
`private ReplyQueue`	`allocConversationReplyObject(int convid)`
`private java.lang.Object[]`	`allocObjectArray()`
`tfmh`	`allocTfmh()`
`void`	`connectionHasTerminated()`
`void`	`dispatch(tfmh tmmsg)`
`InvokeSvc`	`get_invoker()`
`ConversationReply`	`getConversationReply(int convid)`
`private byte[]`	`getTranXID(tfmh tmmsg)`
`boolean`	`isTerm()`
`boolean`	`remove_rplyObj(SessionAcallDescriptor cd)`
`boolean`	`remove_rplyXidObj(Txid txid)`
`java.lang.Object[]`	`removeReplyObj(SessionAcallDescriptor cd)`
`void`	`restoreExecuteRequestToCache(MuxableExecute me)`
`private void`	`restoreObjectArray(java.lang.Object[] oarr)`
`void`	`restoreTfmhToCache(tfmh msg)`
`void`	`set_BlockTime(long blocktime)`
`void`	`setSessionReference(dsession session)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ostream
```
private transient java.io.DataOutputStream ostream
```
  - rplyObjMap
```
private transient java.util.HashMap rplyObjMap
```
  - rplyXidObjMap
```
private transient java.util.HashMap rplyXidObjMap
```
  - is_term
```
private transient boolean is_term
```
  - dom_protocol
```
private transient int dom_protocol
```
  - local_domain_name
```
private transient java.lang.String local_domain_name
```
  - myGwatmi
```
private transient gwatmi myGwatmi
```
  - myInvoker
```
private transient InvokeSvc myInvoker
```
  - mySession
```
private transient dsession mySession
```
  - uid
```
private int uid
```
  - useBetaFeatures
```
private BetaFeatures useBetaFeatures
```
  - myTimeService
```
private transient java.util.Timer myTimeService
```
  - myBlocktime
```
private transient long myBlocktime
```
  - unknownXidRply
```
private transient TuxXidRply unknownXidRply
```
  - tfmhList
```
private transient java.util.ArrayList tfmhList
```
  - objectArrayList
```
private transient java.util.ArrayList objectArrayList
```
  - dispatchList
```
private transient java.util.ArrayList dispatchList
```
  - conversationReplyObjects
```
private transient java.util.HashMap conversationReplyObjects
```
  - MAXCACHE
```
private static final int MAXCACHE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - rdsession
```
public rdsession(java.io.DataOutputStream dom_ostream,
                 gwatmi ss,
                 InvokeSvc invoke,
                 int protocol,
                 java.lang.String ldn,
                 java.util.Timer timeService,
                 TuxXidRply anXidRply,
                 BetaFeatures betaFeatures)
```
    Parameters:
    
    dom_ostream - The raw network output stream to the GWTDOMAIN
    
    ss - The atmi objec from where I am being used, so that service routines can know on which session to do their own atmi calls
    
    invoke - The invoker object to be used when invoking services
    
    protocol - The remote domain protocol to speak
    
    ldn - The local domain name
    
    timeService - The weblogic time service
    
    anXidRply - The XID reply object used to handle requests from the remote domain concerning unknown XIDs
    
    betaFeatures - true if we are allowed to use beta features
    
    Excluded in public API Reference.
    
    Since transactional messages or service requests will need to send data back to the caller, this object needs to know enough information about the caller to send the proper reply.
- Method Detail
  - set_BlockTime
```
public void set_BlockTime(long blocktime)
```
    Parameters:
    
    blocktime - The default blocktime (in milliseconds)
    
    Excluded in public API Reference.
    
    Sets the default blocktime to be used with this object in milliseconds
  - get_invoker
```
public InvokeSvc get_invoker()
```
    Returns:
    
    The object invoking services
    
    Excluded in public API Reference.
    
    Gets the object that is invoking services
  - isTerm
```
public boolean isTerm()
```
    Returns:
    
    true if the session has been terminated by the remote gateway
    
    Excluded in public API Reference.
    
    This function returns true if the GWTDOMAIN has disconnected our session for whatever reason (normal or abnormal). It should be called by all of the ATMI API to determine if the session is still valid before doing any more work.
  - connectionHasTerminated
```
public void connectionHasTerminated()
```
    Excluded in public API Reference.
    
    Connection has terminated
  - restoreTfmhToCache
```
public void restoreTfmhToCache(tfmh msg)
```
  - allocTfmh
```
public tfmh allocTfmh()
```
    Excluded in public API Reference.
    
    Allocates a new tfmh buffer from the cache
  - restoreExecuteRequestToCache
```
public void restoreExecuteRequestToCache(MuxableExecute me)
```
    Parameters:
    
    me - The muxable request to restor to the cache
    
    Excluded in public API Reference.
    
    Restores a muxable request to the Muxable cache
  - restoreObjectArray
```
private void restoreObjectArray(java.lang.Object[] oarr)
```
    Parameters:
    
    oarr - An object array of at least size three to add to the cache
    
    Excluded in public API Reference.
    
    Restores this object array to the object array cache
  - allocObjectArray
```
private java.lang.Object[] allocObjectArray()
```
    Returns:
    
    An Object[2] array
    
    Excluded in public API Reference.
    
    Allocates an object array of size two. Note that this does not need to be syncronized because all of the places that call this function are synchronized.
  - add_rplyObj
```
public void add_rplyObj(SessionAcallDescriptor cd,
                        ReplyQueue rplyObj,
                        int blocktime,
                        TpacallAsyncReply callBack)
                 throws TPException
```
    Parameters:
    
    cd - The request id for which this reply object refers
    
    rplyObj - The reply object on which to enqueue the reply
    blocktime - Has the following meanings:
    
    If zero, use the default.
    If greater than zero, request should time out after blocktime seconds
    If negative one then this request should not timeout
    callBack - This is the call-back to be invoked when a call-back should be invoked (or null, otherwise)
    
    Throws:
    
    TPException - TPEINVAL if blocktime has an invalid value
    
    Excluded in public API Reference.
    
    This adds a reply object to the map of reply objects. When a reply comes into the system the map of reply objects is first checked, and if the reply matches the key of the reply object, then the reply is put onto the reply object, and not onto the normal reply queue. Note that the same reply object can be used for multiple keys. If a request with the same id is found then the old key/value pair is removed, and this one is added. If cd or rplyObj is null then the map is not modified.
  - addTimeoutRequest
```
public void addTimeoutRequest(int giopReqId,
                              int reqId,
                              long blocktime)
                       throws TPException
```
    Parameters:
    
    giopReqId - The unique request id in GIOP message
    
    reqId - The unique request id in TDOM_TCM
    
    blocktime - The timeout to use on this receive
    
    Throws:
    
    TPException - if schedule timer task failed.
    
    Excluded in public API Reference.
    
    CR239312 Schedule a timer task for a CORBA request.
  - addRplyObjTimeout
```
public boolean addRplyObjTimeout(SessionAcallDescriptor cd,
                                 int blocktime)
```
    Parameters:
    
    cd - The call descriptor to which to add a timeout
    
    blocktime - The timeout to use on this receive
    
    Returns:
    
    true if completed successfully, false otherwise
    
    Excluded in public API Reference.
    
    This adds a timeout to a reply object. This is used in conversations in order to have a blocking timeout for a tprecv. Note that this should *only* be called if the conversation is not transactional (in which case the timeout for the transaction includes all interactions inside the conversation)
  - remove_rplyObj
```
public boolean remove_rplyObj(SessionAcallDescriptor cd)
```
    Parameters:
    
    cd - The request id for which this request is to be cancelled
    
    Returns:
    
    true if the element was removed, false if the element was not found
    
    Excluded in public API Reference.
    
    Removes a reply object from the internal list. This occurs because there has been a timeout. Note that this can also be used to help in construction of a Dead Letter Office.
  - removeReplyObj
```
public java.lang.Object[] removeReplyObj(SessionAcallDescriptor cd)
```
  - addlist
```
private void addlist(tfmh tmmsg,
                     int opcode)
```
    Parameters:
    
    tmmsg - The message to add to the list of recieved messages
    
    opcode - The opcode of the message
    
    Excluded in public API Reference.
    
    This function adds the given message to the message list. If the reply is an outstanding ACALL reply then it will search the list of ACALL handles and properly store the reply according to the proper key.
  - add_rplyXidObj
```
public void add_rplyXidObj(Txid txid,
                           TuxXidRply rplyXidObj,
                           int blocktime)
                    throws TPException
```
    Parameters:
    
    txid - The transaction id for which we are getting a reply
    
    rplyXidObj - The reply object on which to enqueue the reply
    blocktime - Has the following meanings:
    
    If zero, use the default.
    If greater than zero, request should time out after blocktime seconds
    If negative one then this request should not timeout
    Throws:
    
    TPException - TPEINVAL if blocktime has an invalid value
    
    Excluded in public API Reference.
    
    This adds a reply Xid object to the map of reply Xid objects. When a reply comes into the system the map of reply objects is first checked, and if the reply matches the key of the reply object, then the reply is put onto the reply object, and not onto the normal reply queue. Note that the same reply object can be used for multiple keys. If a request with the same id is found then the old key/value pair is removed, and this one is added. If cd or rplyObj is null then the map is not modified.
  - remove_rplyXidObj
```
public boolean remove_rplyXidObj(Txid txid)
```
    Parameters:
    
    txid - The request id for which this request is to be cancelled
    
    Returns:
    
    true if the element was removed, false if the element was not found
    
    Excluded in public API Reference.
    
    Removes a reply Xid object from the internal list. This occurs because there has been a timeout. Note that this can also be used to help in construction of a Dead Letter Office.
  - addXidlist
```
private void addXidlist(tfmh tmmsg)
```
    Parameters:
    
    tmmsg - The message to add to the list of recieved messages
    
    Excluded in public API Reference.
    
    This function adds the given message to the message list. If the reply is an outstanding transaction reply then it will search the list of reply handles and properly store the reply according to the proper key.
  - allocConversationReplyObject
```
private ReplyQueue allocConversationReplyObject(int convid)
```
    Excluded in public API Reference.
    
    Adds a conversation reply object to the list of conversation reply objects maintained by this receive session. This is for new conversations
  - getConversationReply
```
public ConversationReply getConversationReply(int convid)
```
    Returns:
    
    null if not found, non-null if this is reply object for this conv
    
    Excluded in public API Reference.
    
    Gets the conversation reply object from the list maintained for new conversations. It will also remove the object from the maintained list
  - dispatch
```
public void dispatch(tfmh tmmsg)
```
    Excluded in public API Reference.
    
    This is the implementation of the thread that is to run reading messages from the GWTDOMAIN and putting them into the list of waiting messages.
  - setSessionReference
```
public void setSessionReference(dsession session)
```
    Parameters:
    
    the - current session it is running with
    
    Excluded in public API Reference.
    
    set up session reference information for security.
  - getTranXID
```
private byte[] getTranXID(tfmh tmmsg)
```

Class rdsession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ostream

rplyObjMap

rplyXidObjMap

is_term

dom_protocol

local_domain_name

myGwatmi

myInvoker

mySession

uid

useBetaFeatures

myTimeService

myBlocktime

unknownXidRply

tfmhList

objectArrayList

dispatchList

conversationReplyObjects

MAXCACHE

Constructor Detail

rdsession

Method Detail

set_BlockTime

get_invoker

isTerm

connectionHasTerminated

restoreTfmhToCache

allocTfmh

restoreExecuteRequestToCache

restoreObjectArray

allocObjectArray

add_rplyObj

addTimeoutRequest

addRplyObjTimeout

remove_rplyObj

removeReplyObj

addlist

add_rplyXidObj

remove_rplyXidObj

addXidlist

allocConversationReplyObject

getConversationReply

dispatch

setSessionReference

getTranXID