InputPDU (UnetStack 3.4.0 API)

org.arl.unet.InputPDU

A utility class to help decode PDUs.
This class extends a ByteArrayInputStream and adds methods to help read from PDUs.

Constructor Summary

Constructors
Constructor and description
`InputPDU (byte[] pdu)` Constructs a PDU from byte buffer.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`length()` Gets the length of PDU.
	`int`	`read(byte[] buf)` Reads a byte buffer from the PDU.
	`int`	`read16()` Reads a signed 16-bit word from the PDU.
	`int`	`read16u()` Reads an unsigned 16-bit word from the PDU.
	`int`	`read24()` Reads a signed 24-bit word from the PDU.
	`int`	`read24u()` Reads an unsigned 24-bit word from the PDU.
	`int`	`read32()` Reads a signed 32-bit word from the PDU.
	`long`	`read32u()` Reads an unsigned 32-bit word from the PDU.
	`long`	`read48()` Reads a signed 48-bit word from the PDU.
	`long`	`read48u()` Reads an unsigned 48-bit word from the PDU.
	`int`	`read8()` Reads a signed byte from the PDU.
	`int`	`read8u()` Reads an unsigned byte from the PDU.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ByteArrayInputStream`	`read, read, close, mark, skip, available, markSupported, reset, read, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public InputPDU(byte[] pdu)
    
    Constructs a PDU from byte buffer.
    Parameters:
    pdu - byte buffer
- Method Detail
  - public int length()
    
    Gets the length of PDU.
    Returns:
    length of PDU
  - @Override public int read(byte[] buf)
    
    Reads a byte buffer from the PDU.
    Parameters:
    buf - buffer to fill
    Returns:
    number of bytes read, or -1 if no more data available
  - public int read16()
    
    Reads a signed 16-bit word from the PDU.
    Returns:
    next word interpreted as a signed number, or 0 if no more data available
  - public int read16u()
    
    Reads an unsigned 16-bit word from the PDU.
    Returns:
    next word interpreted as an unsigned number, or -1 if no more data available
  - public int read24()
    
    Reads a signed 24-bit word from the PDU.
    Returns:
    next word interpreted as a signed number, or 0 if no more data available
  - public int read24u()
    
    Reads an unsigned 24-bit word from the PDU.
    Returns:
    next word interpreted as an unsigned number, or -1 if no more data available
  - public int read32()
    
    Reads a signed 32-bit word from the PDU.
    Returns:
    next word interpreted as a signed number, or 0 if no more data available
  - public long read32u()
    
    Reads an unsigned 32-bit word from the PDU.
    Returns:
    next word interpreted as an unsigned number, or -1 if no more data available
  - public long read48()
    
    Reads a signed 48-bit word from the PDU.
    Returns:
    next word interpreted as a signed number, or 0 if no more data available
  - public long read48u()
    
    Reads an unsigned 48-bit word from the PDU.
    Returns:
    next word interpreted as an unsigned number, or -1 if no more data available
  - public int read8()
    
    Reads a signed byte from the PDU.
    Returns:
    next byte interpreted as a signed number, or 0 if no more data available
  - public int read8u()
    
    Reads an unsigned byte from the PDU.
    Returns:
    next byte interpreted as an unsigned number, or -1 if no more data available

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class InputPDU

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public InputPDU(byte[] pdu)

Method Detail

public int length()

@Override public int read(byte[] buf)

public int read16()

public int read16u()

public int read24()

public int read24u()

public int read32()

public long read32u()

public long read48()

public long read48u()

public int read8()

public int read8u()