Oracle

weblogic.wtc.jatmi
Interface TypedBuffer

All Known Implementing Classes:
MBStringTypes, StandardTypes, TypedCArray, TypedFML, TypedFML32, TypedMBString, TypedString, TypedView, TypedView32, TypedXML, TypedXOctet

public interface TypedBuffer

This interface is for TypedBuffers. Typed buffers must all implement the getType and getSubtype API, which take the place of the regular atmi function tptypes. Furthermore, they must implement _tmpresend and _tmpostrecv, which put the TypedBuffer object into encoded format or decode the encoded format. This is similar functionality to the Serializable interface, except that these functions must encode their objects in the format expected by the TUXEDO System (which, generally is XDR based).


Method Summary
 void _tmpostrecv(DataInputStream decoder, int recv_size)
          This function takes an encoded byte array and and fills in the object it corresponding object.
 void _tmpresend(DataOutputStream encoder)
          This function presends and encodes the given TypedBuffer object.
 int getHintIndex()
          This function returns the hint index for this type and subtype.
 String getSubtype()
          This function returns the string version of the subtype of this buffer.
 String getType()
          This function returns the string version of the type of this buffer.
 

Method Detail

getHintIndex

int getHintIndex()
This function returns the hint index for this type and subtype. In ATMI TypedBuffers are referred to by an index number. BEA has reserved the index numbers 0-15 for internal types. The public index begins at 16. The index numbers come from the position of the buffer type in the buffer type switch table. So, for example, CARRAY has an index of 16, STRING has an index of 17 and so on. If you have created your own buffer type there is distinct performance improvement in giving your new TypedBuffer the same index as it would have on your native TUXEDO system.

Returns:
an integer representing the typeswitch index for this TypedBuffer.

getType

String getType()
This function returns the string version of the type of this buffer.

Returns:
a String object that represents the type of this buffer

getSubtype

String getSubtype()
This function returns the string version of the subtype of this buffer.

Returns:
a String object that represents the subtype of this buffer. May return NULL or the empty string if there is no subtype associated with this buffer

_tmpresend

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.

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

void _tmpostrecv(DataInputStream decoder,
                 int recv_size)
                 throws TPException,
                        IOException
This function takes an encoded byte array and and fills in the object it corresponding object. It is equivalent to the combination of _tmencdec and _tmpostrecv functions from the buffer(3i) TUXEDO manual page.

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