Oracle

weblogic.wtc.jatmi
Class TypedXOctet

java.lang.Object
  extended by weblogic.wtc.jatmi.StandardTypes
      extended by weblogic.wtc.jatmi.TypedXOctet
All Implemented Interfaces:
Serializable, TypedBuffer

public final class TypedXOctet
extends StandardTypes
implements TypedBuffer

This is the jatmi analogue to the X_OCTET Tuxedo buffer type. X_OCTET is the XATMI version of a CARRAY buffer. X_OCTET buffers are treated identically to CARRAYs.

See Also:
TypedCArray, StandardTypes, TypedBuffer, Serialized Form

Field Summary
 byte[] carray
          The binary data to send to the remote TUXEDO domain.
 int sendSize
          The amount of data in carray to send.
 
Fields inherited from class weblogic.wtc.jatmi.StandardTypes
CALLOUT_HINT, CARRAY_HINT, CMPS_HDR_HINT, COMPOS_HINT, FML_HINT, FML32_HINT, MBSTRING_HINT, MTTYP_HINT, PROP_HINT, ROUTE_HINT, RPCRP_HINT, RPCRQ_HINT, STRING_HINT, TDOM_VALS_HINT, TGIOP_HINT, TM_HINT, TPINITTYPE_HINT, TRAN_HINT, UNSOL_HINT, VIEW_HINT, VIEW32_HINT, WS_HINT, WSRPCRQ_HINT, X_C_TYPE_HINT, X_COMMON_HINT, X_OCTET_HINT, XML_HINT
 
Constructor Summary
TypedXOctet()
          Default constructor; carray is NULL, sendSize 0.
TypedXOctet(int length)
          Creates an empty byte array of the given size.
 
Method Summary
 void _tmpostrecv(DataInputStream decoder, int recv_size)
          XDR decodes the given carray.
 void _tmpresend(DataOutputStream encoder)
          This function presends and encodes the given TypedBuffer object.
 int getSendSize()
          Gets the amount of data to send in carray.
 void setSendSize(int aSendSize)
          Sets the amount of data to send in carray.
 
Methods inherited from class weblogic.wtc.jatmi.StandardTypes
getHintIndex, getSubtype, getType, hint_to_type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface weblogic.wtc.jatmi.TypedBuffer
getHintIndex, getSubtype, getType
 

Field Detail

carray

public byte[] carray
The binary data to send to the remote TUXEDO domain.


sendSize

public int sendSize
The amount of data in carray to send.

Constructor Detail

TypedXOctet

public TypedXOctet()
Default constructor; carray is NULL, sendSize 0.


TypedXOctet

public TypedXOctet(int length)
Creates an empty byte array of the given size.

Parameters:
length - The size of the byte array to generate. sendSize will be initialized to length.
Method Detail

getSendSize

public int getSendSize()
Gets the amount of data to send in carray.

Returns:
The amount of data in carray that will be sent.

setSendSize

public void setSendSize(int aSendSize)
Sets the amount of data to send in carray.

Parameters:
aSendSize - The amount of data in carray to send.

_tmpresend

public void _tmpresend(DataOutputStream encoder)
                throws TPException,
                       IOException
This function presends and encodes the given TypedBuffer object. It is equivalent to the combination of _tmpresend and _tmencdec functions from the buffer(3i) TUXEDO manual page.

XDR encodes the given carray. XDR encoding of a carray is simply the carray itself. The returned byte array will be exactly sendSize bytes.

Specified by:
_tmpresend in interface TypedBuffer
Parameters:
encoder - The output stream to encode this type to. Should not be padded.
Throws:
TPException -
  • TPEINVAL - If there was some problem with the state of the TypedBuffer.
  • Any other errno is considered a fatal error.
IOException - If there was an error writing to the DataOutputStream.

_tmpostrecv

public void _tmpostrecv(DataInputStream decoder,
                        int recv_size)
                 throws TPException,
                        IOException
XDR decodes the given carray. XDR encoding of a carray is simply the carray itself. The amount of data in the carray is determined by the input recv_size parameter.

Specified by:
_tmpostrecv in interface TypedBuffer
Parameters:
decoder - A stream that starts with the encoded data for this buffer type. Only recv_size bytes should be read from the stream (though at the time this function is called all bytes necessary to decode this type should be available).
recv_size - The total size of encoded data from the start position (note that encoded may be larger than the actual recieved size).
Throws:
TPException - TPEINVAL if this stream could not be decoded for any reason.
IOException - if there was an error reading from the stream

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111
Copyright 1996,2009, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Part Number E13941-01
Oracle WebLogic Server 10.3.1 API Reference