Cell (Orchid 1.0 API)

All Known Subinterfaces:

RelayCell

All Known Implementing Classes:

CellImpl, RelayCellImpl
```
public interface Cell
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDRESS_TYPE_HOSTNAME`
`static int`	`ADDRESS_TYPE_IPV4`
`static int`	`ADRESS_TYPE_IPV6`
`static int`	`AUTH_CHALLENGE`
`static int`	`AUTHENTICATE`
`static int`	`AUTHORIZE`
`static int`	`CELL_HEADER_LEN` The length of a standard cell header.
`static int`	`CELL_LEN` The fixed size of a standard cell.
`static int`	`CELL_PAYLOAD_LEN` The length of the payload space in a standard cell.
`static int`	`CELL_VAR_HEADER_LEN` The header length for a variable length cell (ie: VERSIONS)
`static int`	`CERTS`
`static int`	`CREATE` Command constant for a CREATE type cell.
`static int`	`CREATE_FAST` Command constant for a CREATE_FAST type cell.
`static int`	`CREATED` Command constant for a CREATED type cell.
`static int`	`CREATED_FAST` Command constant for a CREATED_FAST type cell.
`static int`	`DESTROY` Command constant for a DESTROY type cell.
`static int`	`ERROR_CONNECTFAILED`
`static int`	`ERROR_DESTROYED`
`static int`	`ERROR_FINISHED`
`static int`	`ERROR_HIBERNATING`
`static int`	`ERROR_INTERNAL`
`static int`	`ERROR_NONE`
`static int`	`ERROR_NOSUCHSERVICE`
`static int`	`ERROR_OR_CONN_CLOSED`
`static int`	`ERROR_OR_IDENTITY`
`static int`	`ERROR_PROTOCOL`
`static int`	`ERROR_REQUESTED`
`static int`	`ERROR_RESOURCELIMIT`
`static int`	`ERROR_TIMEOUT`
`static int`	`NETINFO` Command constant for a NETINFO type cell.
`static int`	`PADDING` Command constant for a PADDING type cell.
`static int`	`RELAY` Command constant for a RELAY type cell.
`static int`	`RELAY_EARLY` Command constant for a RELAY_EARLY type cell.
`static int`	`VERSIONS` Command constant for a VERSIONS type cell.
`static int`	`VPADDING`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`cellBytesConsumed()` Return the number of bytes already packed (for outgoing cells) or unpacked (for incoming cells).
`int`	`cellBytesRemaining()` Return the number of bytes remaining between the current internal pointer and the end of the cell.
`int`	`getByte()` Return the next byte from the cell and increment the internal pointer by one byte.
`void`	`getByteArray(byte[] buffer)` Copy `buffer.length` bytes from the cell into `buffer`.
`int`	`getByteAt(int index)` Return the byte at the specified offset into the cell.
`byte[]`	`getCellBytes()` Return the entire cell data as a raw array of bytes.
`int`	`getCircuitId()` Return the circuit id field from this cell.
`int`	`getCommand()` Return the command field from this cell.
`int`	`getInt()` Return the next 32-bit big endian value from the cell and increment the internal pointer by four bytes.
`int`	`getShort()` Return the next 16-bit big endian value from the cell and increment the internal pointer by two bytes.
`int`	`getShortAt(int index)` Return the 16-bit big endian value at the specified offset into the cell.
`void`	`putByte(int value)` Store a byte at the current pointer location and increment the pointer by one byte.
`void`	`putByteArray(byte[] data)` Store the entire array `data` at the current pointer location and increment the pointer by `data.length` bytes.
`void`	`putByteArray(byte[] data, int offset, int length)` Store `length` bytes of the byte array `data` starting from `offset` into the array at the current pointer location and increment the pointer by `length` bytes.
`void`	`putByteAt(int index, int value)` Store a byte at the specified offset into the cell.
`void`	`putInt(int value)` Store a 32-bit integer value in big endian order at the current pointer location and increment the pointer by 4 bytes.
`void`	`putShort(int value)` Store a 16-bit short value in big endian order at the current pointer location and increment the pointer by two bytes.
`void`	`putShortAt(int index, int value)` Store a 16-bit short value in big endian byte order at the specified offset into the cell and increment the pointer by two bytes.
`void`	`putString(String string)`
`void`	`resetToPayload()` Set the internal pointer to the first byte after the cell header.

- Field Detail
  - PADDING
```
static final int PADDING
```
    Command constant for a PADDING type cell.
    
    See Also:
    
    Constant Field Values
  - CREATE
```
static final int CREATE
```
    Command constant for a CREATE type cell.
    
    See Also:
    
    Constant Field Values
  - CREATED
```
static final int CREATED
```
    Command constant for a CREATED type cell.
    
    See Also:
    
    Constant Field Values
  - RELAY
```
static final int RELAY
```
    Command constant for a RELAY type cell.
    
    See Also:
    
    Constant Field Values
  - DESTROY
```
static final int DESTROY
```
    Command constant for a DESTROY type cell.
    
    See Also:
    
    Constant Field Values
  - CREATE_FAST
```
static final int CREATE_FAST
```
    Command constant for a CREATE_FAST type cell.
    
    See Also:
    
    Constant Field Values
  - CREATED_FAST
```
static final int CREATED_FAST
```
    Command constant for a CREATED_FAST type cell.
    
    See Also:
    
    Constant Field Values
  - VERSIONS
```
static final int VERSIONS
```
    Command constant for a VERSIONS type cell.
    
    See Also:
    
    Constant Field Values
  - NETINFO
```
static final int NETINFO
```
    Command constant for a NETINFO type cell.
    
    See Also:
    
    Constant Field Values
  - RELAY_EARLY
```
static final int RELAY_EARLY
```
    Command constant for a RELAY_EARLY type cell.
    
    See Also:
    
    Constant Field Values
  - VPADDING
```
static final int VPADDING
```
    See Also:
    
    Constant Field Values
  - CERTS
```
static final int CERTS
```
    See Also:
    
    Constant Field Values
  - AUTH_CHALLENGE
```
static final int AUTH_CHALLENGE
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATE
```
static final int AUTHENTICATE
```
    See Also:
    
    Constant Field Values
  - AUTHORIZE
```
static final int AUTHORIZE
```
    See Also:
    
    Constant Field Values
  - ERROR_NONE
```
static final int ERROR_NONE
```
    See Also:
    
    Constant Field Values
  - ERROR_PROTOCOL
```
static final int ERROR_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - ERROR_INTERNAL
```
static final int ERROR_INTERNAL
```
    See Also:
    
    Constant Field Values
  - ERROR_REQUESTED
```
static final int ERROR_REQUESTED
```
    See Also:
    
    Constant Field Values
  - ERROR_HIBERNATING
```
static final int ERROR_HIBERNATING
```
    See Also:
    
    Constant Field Values
  - ERROR_RESOURCELIMIT
```
static final int ERROR_RESOURCELIMIT
```
    See Also:
    
    Constant Field Values
  - ERROR_CONNECTFAILED
```
static final int ERROR_CONNECTFAILED
```
    See Also:
    
    Constant Field Values
  - ERROR_OR_IDENTITY
```
static final int ERROR_OR_IDENTITY
```
    See Also:
    
    Constant Field Values
  - ERROR_OR_CONN_CLOSED
```
static final int ERROR_OR_CONN_CLOSED
```
    See Also:
    
    Constant Field Values
  - ERROR_FINISHED
```
static final int ERROR_FINISHED
```
    See Also:
    
    Constant Field Values
  - ERROR_TIMEOUT
```
static final int ERROR_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - ERROR_DESTROYED
```
static final int ERROR_DESTROYED
```
    See Also:
    
    Constant Field Values
  - ERROR_NOSUCHSERVICE
```
static final int ERROR_NOSUCHSERVICE
```
    See Also:
    
    Constant Field Values
  - ADDRESS_TYPE_HOSTNAME
```
static final int ADDRESS_TYPE_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - ADDRESS_TYPE_IPV4
```
static final int ADDRESS_TYPE_IPV4
```
    See Also:
    
    Constant Field Values
  - ADRESS_TYPE_IPV6
```
static final int ADRESS_TYPE_IPV6
```
    See Also:
    
    Constant Field Values
  - CELL_LEN
```
static final int CELL_LEN
```
    The fixed size of a standard cell.
    
    See Also:
    
    Constant Field Values
  - CELL_HEADER_LEN
```
static final int CELL_HEADER_LEN
```
    The length of a standard cell header.
    
    See Also:
    
    Constant Field Values
  - CELL_VAR_HEADER_LEN
```
static final int CELL_VAR_HEADER_LEN
```
    The header length for a variable length cell (ie: VERSIONS)
    
    See Also:
    
    Constant Field Values
  - CELL_PAYLOAD_LEN
```
static final int CELL_PAYLOAD_LEN
```
    The length of the payload space in a standard cell.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCircuitId
```
int getCircuitId()
```
    Return the circuit id field from this cell.
    
    Returns:
    
    The circuit id field of this cell.
  - getCommand
```
int getCommand()
```
    Return the command field from this cell.
    
    Returns:
    
    The command field of this cell.
  - resetToPayload
```
void resetToPayload()
```
    Set the internal pointer to the first byte after the cell header.
  - getByte
```
int getByte()
```
    Return the next byte from the cell and increment the internal pointer by one byte.
    
    Returns:
    
    The byte at the current pointer location.
  - getByteAt
```
int getByteAt(int index)
```
    Return the byte at the specified offset into the cell.
    
    Parameters:
    
    index - The cell offset.
    
    Returns:
    
    The byte at the specified offset.
  - getShort
```
int getShort()
```
    Return the next 16-bit big endian value from the cell and increment the internal pointer by two bytes.
    
    Returns:
    
    The 16-bit short value at the current pointer location.
  - getShortAt
```
int getShortAt(int index)
```
    Return the 16-bit big endian value at the specified offset into the cell.
    
    Parameters:
    
    index - The cell offset.
    
    Returns:
    
    The 16-bit short value at the specified offset.
  - getInt
```
int getInt()
```
    Return the next 32-bit big endian value from the cell and increment the internal pointer by four bytes.
    
    Returns:
    
    The 32-bit integer value at the current pointer location.
  - getByteArray
```
void getByteArray(byte[] buffer)
```
    Copy buffer.length bytes from the cell into buffer. The data is copied starting from the current internal pointer location and afterwards the internal pointer is incremented by buffer.length bytes.
    
    Parameters:
    
    buffer - The array of bytes to copy the cell data into.
  - cellBytesConsumed
```
int cellBytesConsumed()
```
    Return the number of bytes already packed (for outgoing cells) or unpacked (for incoming cells). This is equivalent to the internal pointer position.
    
    Returns:
    
    The number of bytes already consumed from this cell.
  - cellBytesRemaining
```
int cellBytesRemaining()
```
    Return the number of bytes remaining between the current internal pointer and the end of the cell. If fields are being added to a new cell for transmission then this value indicates the remaining space in bytes for adding new data. If fields are being read from a received cell then this value describes the number of bytes which can be read without overflowing the cell.
    
    Returns:
    
    The number of payload bytes remaining in this cell.
  - putByte
```
void putByte(int value)
```
    Store a byte at the current pointer location and increment the pointer by one byte.
    
    Parameters:
    
    value - The byte value to store.
  - putByteAt
```
void putByteAt(int index,
               int value)
```
    Store a byte at the specified offset into the cell.
    
    Parameters:
    
    index - The offset in bytes into the cell.
    
    value - The byte value to store.
  - putShort
```
void putShort(int value)
```
    Store a 16-bit short value in big endian order at the current pointer location and increment the pointer by two bytes.
    
    Parameters:
    
    value - The 16-bit short value to store.
  - putShortAt
```
void putShortAt(int index,
                int value)
```
    Store a 16-bit short value in big endian byte order at the specified offset into the cell and increment the pointer by two bytes.
    
    Parameters:
    
    index - The offset in bytes into the cell.
    
    value - The 16-bit short value to store.
  - putInt
```
void putInt(int value)
```
    Store a 32-bit integer value in big endian order at the current pointer location and increment the pointer by 4 bytes.
    
    Parameters:
    
    value - The 32-bit integer value to store.
  - putByteArray
```
void putByteArray(byte[] data)
```
    Store the entire array data at the current pointer location and increment the pointer by data.length bytes.
    
    Parameters:
    
    data - The array of bytes to store in the cell.
  - putByteArray
```
void putByteArray(byte[] data,
                  int offset,
                  int length)
```
    Store length bytes of the byte array data starting from offset into the array at the current pointer location and increment the pointer by length bytes.
    
    Parameters:
    
    data - The source array of bytes.
    
    offset - The offset into the source array.
    
    length - The number of bytes from the source array to store.
  - getCellBytes
```
byte[] getCellBytes()
```
    Return the entire cell data as a raw array of bytes. For all cells except VERSIONS, this array will be exactly CELL_LEN bytes long.
    
    Returns:
    
    The cell data as an array of bytes.
  - putString
```
void putString(String string)
```

Interface Cell

Field Summary

Method Summary

Field Detail

PADDING

CREATE

CREATED

RELAY

DESTROY

CREATE_FAST

CREATED_FAST

VERSIONS

NETINFO

RELAY_EARLY

VPADDING

CERTS

AUTH_CHALLENGE

AUTHENTICATE

AUTHORIZE

ERROR_NONE

ERROR_PROTOCOL

ERROR_INTERNAL

ERROR_REQUESTED

ERROR_HIBERNATING

ERROR_RESOURCELIMIT

ERROR_CONNECTFAILED

ERROR_OR_IDENTITY

ERROR_OR_CONN_CLOSED

ERROR_FINISHED

ERROR_TIMEOUT

ERROR_DESTROYED

ERROR_NOSUCHSERVICE

ADDRESS_TYPE_HOSTNAME

ADDRESS_TYPE_IPV4

ADRESS_TYPE_IPV6

CELL_LEN

CELL_HEADER_LEN

CELL_VAR_HEADER_LEN

CELL_PAYLOAD_LEN

Method Detail

getCircuitId

getCommand

resetToPayload

getByte

getByteAt

getShort

getShortAt

getInt

getByteArray

cellBytesConsumed

cellBytesRemaining

putByte

putByteAt

putShort

putShortAt

putInt

putByteArray

putByteArray

getCellBytes

putString