MessageParserImpl (GlassFish Corba ORB 4.2.1 API)

java.lang.Object
- com.sun.corba.ee.impl.protocol.MessageParserImpl

All Implemented Interfaces:

MessageParser
```
public class MessageParserImpl
extends Object
implements MessageParser
```
An implementation of a MessageParser that knows how to parse bytes into a GIOP protocol data unit.

Constructor Summary

Constructors
Constructor and Description

MessageParserImpl(ORB orb)
Creates a new instance of MessageParserImpl

MessageParserImpl(ORB orb, Connection connection)

Constructors
Constructor and Description
`MessageParserImpl(ORB orb)` Creates a new instance of MessageParserImpl
`MessageParserImpl(ORB orb, Connection connection)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkTimeout(long timeSinceLastInput)` Checks for a stalled or rogue client.
`MessageMediator`	`getMessageMediator()` Returns the full message constructed by the last call to `MessageParser.offerBuffer(ByteBuffer)`.
`ByteBuffer`	`getMsgByteBuffer()` Returns the byte buffer (if any) associated with the last message returned.
`ByteBuffer`	`getNewBufferAndCopyOld(ByteBuffer byteBuffer)`
`int`	`getNextMessageStartPosition()` Get the starting position where the next message in the `ByteBuffer` given to `parseBytes()` begins.
`ByteBuffer`	`getRemainderBuffer()` Returns a buffer containing whatever is left after processing the buffer provided in `MessageParser.offerBuffer(ByteBuffer)`, which could be the same buffer.
`int`	`getSizeNeeded()` Return the suggested number of bytes needed to hold the next message to be parsed.
`boolean`	`hasMoreBytesToParse()` Are there more bytes to be parsed in the `ByteBuffer` given to this MessageParser's `parseBytes` ? This method is typically called after a call to `parseBytes()` to determine if the `ByteBuffer` has more bytes which need to parsed into a `Message`.
`boolean`	`isExpectingFragments()`
`boolean`	`isExpectingMoreData()` Is this MessageParser expecting more data ?
`void`	`offerBuffer(ByteBuffer buffer)` Offers an input buffer to the parser.
`Message`	`parseBytes(ByteBuffer byteBuffer, Connection connection)` If there are sufficient bytes in the `ByteBuffer` to compose a `Message`, then return a newly initialized `Message`.
`void`	`setNextMessageStartPosition(int position)` Set the starting position where the next message in the `ByteBuffer` given to `parseBytes()` begins.
`String`	`toString()` Return a string representing this MessageParser's state

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

- Constructor Detail
  - MessageParserImpl
```
public MessageParserImpl(ORB orb)
```
    Creates a new instance of MessageParserImpl
  - MessageParserImpl
```
public MessageParserImpl(ORB orb,
                         Connection connection)
```
- Method Detail
  - getNewBufferAndCopyOld
```
public ByteBuffer getNewBufferAndCopyOld(ByteBuffer byteBuffer)
```
    Specified by:
    
    getNewBufferAndCopyOld in interface MessageParser
  - isExpectingMoreData
```
public boolean isExpectingMoreData()
```
    Is this MessageParser expecting more data ?
    
    Specified by:
    
    isExpectingMoreData in interface MessageParser
    
    Returns:
    
    - True if more bytes are needed to construct at least one GIOP protocol data unit. False, if no additional bytes are remain to be parsed into a GIOP protocol data unit.
  - isExpectingFragments
```
public boolean isExpectingFragments()
```
    Specified by:
    
    isExpectingFragments in interface MessageParser
  - getMsgByteBuffer
```
public ByteBuffer getMsgByteBuffer()
```
    Description copied from interface: MessageParser
    
    Returns the byte buffer (if any) associated with the last message returned.
    
    Specified by:
    
    getMsgByteBuffer in interface MessageParser
  - offerBuffer
```
public void offerBuffer(ByteBuffer buffer)
```
    Description copied from interface: MessageParser
    
    Offers an input buffer to the parser. Position must be set to 0, and the buffer must contain at least the start of a GIOP message. The parser will consume what it can and make the remainder available in MessageParser.getRemainderBuffer()
    
    Specified by:
    
    offerBuffer in interface MessageParser
    
    Parameters:
    
    buffer - a buffer containing at least the start of a GIOP message.
  - getRemainderBuffer
```
public ByteBuffer getRemainderBuffer()
```
    Description copied from interface: MessageParser
    
    Returns a buffer containing whatever is left after processing the buffer provided in MessageParser.offerBuffer(ByteBuffer), which could be the same buffer. The buffer could also be null if all data has been consumed.
    
    Specified by:
    
    getRemainderBuffer in interface MessageParser
    
    Returns:
    
    a byte buffer representing data which still needs to be processed.
  - getMessageMediator
```
public MessageMediator getMessageMediator()
```
    Description copied from interface: MessageParser
    
    Returns the full message constructed by the last call to MessageParser.offerBuffer(ByteBuffer). Will be null if the last such call did not complete a message.
    
    Specified by:
    
    getMessageMediator in interface MessageParser
    
    Returns:
    
    a complete message, wrapped in a message mediator.
  - checkTimeout
```
public void checkTimeout(long timeSinceLastInput)
```
    Description copied from interface: MessageParser
    
    Checks for a stalled or rogue client. If in the middle of receiving a message and the time exceeds the limit, will throw a communications failure exception.
    
    Specified by:
    
    checkTimeout in interface MessageParser
    
    Parameters:
    
    timeSinceLastInput - the number of milliseconds since the last input was received.
  - parseBytes
```
public Message parseBytes(ByteBuffer byteBuffer,
                          Connection connection)
```
    Description copied from interface: MessageParser
    
    If there are sufficient bytes in the ByteBuffer to compose a Message, then return a newly initialized Message. Otherwise, return null. When this method is first called, it is assumed that ByteBuffer.position() points to the location in the ByteBuffer where the beginning of the first Message begins. If there is no partial Message remaining in the ByteBuffer when this method exits, this method will e this.expectingMoreData to false. Otherwise, it will be set to true. Callees of this method may check isExpectingMoreData() subsequently to determine if this MessageParser is expecting more data to complete a protocol data unit. Callees may also subsequently check hasMoreBytesToParse() to determine if this MessageParser has more data to parse in the given ByteBuffer.
    
    Specified by:
    
    parseBytes in interface MessageParser
    
    Returns:
    
    Message if one is found in the ByteBuffer. Otherwise, returns null.
  - hasMoreBytesToParse
```
public boolean hasMoreBytesToParse()
```
    Are there more bytes to be parsed in the ByteBuffer given to this MessageParser's parseBytes ? This method is typically called after a call to parseBytes() to determine if the ByteBuffer has more bytes which need to parsed into a Message.
    
    Specified by:
    
    hasMoreBytesToParse in interface MessageParser
    
    Returns:
    
    true if there are more bytes to be parsed. Otherwise false.
  - setNextMessageStartPosition
```
public void setNextMessageStartPosition(int position)
```
    Set the starting position where the next message in the ByteBuffer given to parseBytes() begins.
    
    Specified by:
    
    setNextMessageStartPosition in interface MessageParser
  - getNextMessageStartPosition
```
public int getNextMessageStartPosition()
```
    Get the starting position where the next message in the ByteBuffer given to parseBytes() begins.
    
    Specified by:
    
    getNextMessageStartPosition in interface MessageParser
  - toString
```
public String toString()
```
    Return a string representing this MessageParser's state
    
    Overrides:
    
    toString in class Object
  - getSizeNeeded
```
public int getSizeNeeded()
```
    Return the suggested number of bytes needed to hold the next message to be parsed.
    
    Specified by:
    
    getSizeNeeded in interface MessageParser

Class MessageParserImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageParserImpl

MessageParserImpl

Method Detail

getNewBufferAndCopyOld

isExpectingMoreData

isExpectingFragments

getMsgByteBuffer

offerBuffer

getRemainderBuffer

getMessageMediator

checkTimeout

parseBytes

hasMoreBytesToParse

setNextMessageStartPosition

getNextMessageStartPosition

toString

getSizeNeeded