AdsHeader

java.lang.Object
- stella.net.ads.protocol.AdsHeader

```
public class AdsHeader
extends Object
```
This class represents an ADS header. It can be parsed from a byte buffer with parse(java.nio.ByteBuffer) or it can be appended to a byte buffer with
In essence, this header is the combined object from an AMS-TCP header and a pure AMS header.

Author:

wooz

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AMSHEADER` Length of the AMS header.
`private int`	`command`
`private int`	`error`
`private int`	`flag`
`static int`	`HEADER` Length of ADS header in bytes.
`private int`	`id`
`private long`	`payload`
`private int`	`reserved`
`private byte[]`	`source`
`private int`	`sourceport`
`private byte[]`	`target`
`private int`	`targetport`
`static int`	`TCPHEADER` Length of the TCP header.
`private long`	`total`

Constructor Summary

Constructors
Constructor and Description
`AdsHeader(int r, long t, byte[] tadd, int tp, byte[] sadd, int sp, int c, int f, long payl, int err, int ii)` Fully qualified ADS header.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`getCommand()` Command ID.
`int`	`getError()` The error code
`int`	`getFlag()` In TCP, only two flags are allowed 0x04 for command request, 0x41 for command response.
`int`	`getId()` The communication ID.
`long`	`getPayloadLength()` Length of payload in bytes.
`int`	`getReserved()` Must be zero
`byte[]`	`getSource()` A logical IP-style address of the source, consisting of six(!) bytes in network order.
`int`	`getSourcePort()` Sender port number
`byte[]`	`getTarget()` A logical IP-style address of the target, consisting of six(!) bytes in network order.
`int`	`getTargetPort()` Target port number
`long`	`getTotal()` Get total length of data packet.
`int`	`hashCode()`
`boolean`	`isError()` For convenience, we return true here if any error was detected.
`static AdsHeader`	`parse(ByteBuffer in)` From a fully filled byte-buffer, we create a possibly valid AdsHeader
`ByteBuffer`	`push(ByteBuffer into)` Push the header into the provided buffer.
`private String`	`stringAmsNetId(byte[] six)`
`String`	`toString()`

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

- Field Detail
  - AMSHEADER
```
public static final int AMSHEADER
```
    Length of the AMS header.
    
    See Also:
    
    Constant Field Values
  - TCPHEADER
```
public static final int TCPHEADER
```
    Length of the TCP header.
    
    See Also:
    
    Constant Field Values
  - HEADER
```
public static final int HEADER
```
    Length of ADS header in bytes.
    
    See Also:
    
    Constant Field Values
  - reserved
```
private final int reserved
```
  - total
```
private final long total
```
  - target
```
private final byte[] target
```
  - targetport
```
private final int targetport
```
  - source
```
private final byte[] source
```
  - sourceport
```
private final int sourceport
```
  - command
```
private final int command
```
  - flag
```
private final int flag
```
  - payload
```
private final long payload
```
  - error
```
private final int error
```
  - id
```
private final int id
```
- Constructor Detail
  - AdsHeader
```
AdsHeader(int r,
          long t,
          byte[] tadd,
          int tp,
          byte[] sadd,
          int sp,
          int c,
          int f,
          long payl,
          int err,
          int ii)
```
    Fully qualified ADS header. If no exception is thrown, this header is always valid.
    
    Parameters:
    
    r -
    
    t -
    
    tadd -
    
    sadd -
    
    p -
    
    c -
    
    f -
    
    payl -
    
    err -
    
    ii -
- Method Detail
  - getReserved
```
public int getReserved()
```
    Must be zero
    
    Returns:
    
    the reserved
  - getTotal
```
public long getTotal()
```
    Get total length of data packet. This includes the 32 bytes of the AMS header plus the data package size.
    
    Returns:
    
    the total
  - getTarget
```
public byte[] getTarget()
```
    A logical IP-style address of the target, consisting of six(!) bytes in network order.
    
    Returns:
    
    the target
  - getSource
```
public byte[] getSource()
```
    A logical IP-style address of the source, consisting of six(!) bytes in network order.
    
    Returns:
    
    the source
  - getSourcePort
```
public int getSourcePort()
```
    Sender port number
    
    Returns:
    
    the port
  - getTargetPort
```
public int getTargetPort()
```
    Target port number
    
    Returns:
    
    the port
  - getCommand
```
public int getCommand()
```
    Command ID. Currently, only few possible values are assigned.
    
    Returns:
    
    the command
  - getFlag
```
public int getFlag()
```
    In TCP, only two flags are allowed 0x04 for command request, 0x41 for command response.
    
    Returns:
    
    the flag
  - getPayloadLength
```
public long getPayloadLength()
```
    Length of payload in bytes.
    
    Returns:
    
    the payload
  - isError
```
public boolean isError()
```
    For convenience, we return true here if any error was detected. The error number can then be queried with getError().
  - getError
```
public int getError()
```
    The error code
    
    Returns:
    
    the error
  - getId
```
public int getId()
```
    The communication ID.
    
    Returns:
    
    the id
  - push
```
public ByteBuffer push(ByteBuffer into)
```
    Push the header into the provided buffer.
    
    Parameters:
    
    into - a pre-allocated byte buffer that must be able to hold the entire package.
    
    Returns:
    
    The argument
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - stringAmsNetId
```
private String stringAmsNetId(byte[] six)
```
  - parse
```
public static AdsHeader parse(ByteBuffer in)
```
    From a fully filled byte-buffer, we create a possibly valid AdsHeader

Class AdsHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AMSHEADER

TCPHEADER

HEADER

reserved

total

target

targetport

source

sourceport

command

flag

payload

error

id

Constructor Detail

AdsHeader

Method Detail

getReserved

getTotal

getTarget

getSource

getSourcePort

getTargetPort

getCommand

getFlag

getPayloadLength

isError

getError

getId

push

hashCode

equals

toString

stringAmsNetId

parse