CellImpl (Orchid 1.1 API)

java.lang.Object
- com.subgraph.orchid.circuits.cells.CellImpl

All Implemented Interfaces:

Cell

Direct Known Subclasses:

RelayCellImpl
```
public class CellImpl
extends Object
implements Cell
```

Field Summary

Fields
Modifier and Type Field and Description

protected ByteBuffer cellBuffer
- Fields inherited from interface com.subgraph.orchid.Cell
  ADDRESS_TYPE_HOSTNAME, ADDRESS_TYPE_IPV4, ADRESS_TYPE_IPV6, AUTH_CHALLENGE, AUTHENTICATE, AUTHORIZE, CELL_HEADER_LEN, CELL_LEN, CELL_PAYLOAD_LEN, CELL_VAR_HEADER_LEN, CERTS, CREATE, CREATE_FAST, CREATED, CREATED_FAST, DESTROY, ERROR_CONNECTFAILED, ERROR_DESTROYED, ERROR_FINISHED, ERROR_HIBERNATING, ERROR_INTERNAL, ERROR_NONE, ERROR_NOSUCHSERVICE, ERROR_OR_CONN_CLOSED, ERROR_OR_IDENTITY, ERROR_PROTOCOL, ERROR_REQUESTED, ERROR_RESOURCELIMIT, ERROR_TIMEOUT, NETINFO, PADDING, RELAY, RELAY_EARLY, VERSIONS, VPADDING

Fields
Modifier and Type	Field and Description
`protected ByteBuffer`	`cellBuffer`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CellImpl(byte[] rawCell)

protected CellImpl(int circuitId, int command)

Constructors
Modifier	Constructor and Description
`protected`	`CellImpl(byte[] rawCell)`
`protected`	`CellImpl(int circuitId, int command)`

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static CellImpl`	`createCell(int circuitId, int command)`
`static CellImpl`	`createVarCell(int circuitId, int command, int payloadLength)`
`static String`	`errorToDescription(int errorCode)`
`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)`
`static CellImpl`	`readFromInputStream(InputStream input)`
`void`	`resetToPayload()` Set the internal pointer to the first byte after the cell header.
`String`	`toString()`

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

- Field Detail
  - cellBuffer
```
protected final ByteBuffer cellBuffer
```
- Constructor Detail
  - CellImpl
```
protected CellImpl(int circuitId,
                   int command)
```
  - CellImpl
```
protected CellImpl(byte[] rawCell)
```
- Method Detail
  - createCell
```
public static CellImpl createCell(int circuitId,
                                  int command)
```
  - createVarCell
```
public static CellImpl createVarCell(int circuitId,
                                     int command,
                                     int payloadLength)
```
  - readFromInputStream
```
public static CellImpl readFromInputStream(InputStream input)
                                    throws IOException
```
    Throws:
    
    IOException
  - getCircuitId
```
public int getCircuitId()
```
    Description copied from interface: Cell
    
    Return the circuit id field from this cell.
    
    Specified by:
    
    getCircuitId in interface Cell
    
    Returns:
    
    The circuit id field of this cell.
  - getCommand
```
public int getCommand()
```
    Description copied from interface: Cell
    
    Return the command field from this cell.
    
    Specified by:
    
    getCommand in interface Cell
    
    Returns:
    
    The command field of this cell.
  - resetToPayload
```
public void resetToPayload()
```
    Description copied from interface: Cell
    
    Set the internal pointer to the first byte after the cell header.
    
    Specified by:
    
    resetToPayload in interface Cell
  - getByte
```
public int getByte()
```
    Description copied from interface: Cell
    
    Return the next byte from the cell and increment the internal pointer by one byte.
    
    Specified by:
    
    getByte in interface Cell
    
    Returns:
    
    The byte at the current pointer location.
  - getByteAt
```
public int getByteAt(int index)
```
    Description copied from interface: Cell
    
    Return the byte at the specified offset into the cell.
    
    Specified by:
    
    getByteAt in interface Cell
    
    Parameters:
    
    index - The cell offset.
    
    Returns:
    
    The byte at the specified offset.
  - getShort
```
public int getShort()
```
    Description copied from interface: Cell
    
    Return the next 16-bit big endian value from the cell and increment the internal pointer by two bytes.
    
    Specified by:
    
    getShort in interface Cell
    
    Returns:
    
    The 16-bit short value at the current pointer location.
  - getInt
```
public int getInt()
```
    Description copied from interface: Cell
    
    Return the next 32-bit big endian value from the cell and increment the internal pointer by four bytes.
    
    Specified by:
    
    getInt in interface Cell
    
    Returns:
    
    The 32-bit integer value at the current pointer location.
  - getShortAt
```
public int getShortAt(int index)
```
    Description copied from interface: Cell
    
    Return the 16-bit big endian value at the specified offset into the cell.
    
    Specified by:
    
    getShortAt in interface Cell
    
    Parameters:
    
    index - The cell offset.
    
    Returns:
    
    The 16-bit short value at the specified offset.
  - getByteArray
```
public void getByteArray(byte[] buffer)
```
    Description copied from interface: Cell
    
    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.
    
    Specified by:
    
    getByteArray in interface Cell
    
    Parameters:
    
    buffer - The array of bytes to copy the cell data into.
  - cellBytesConsumed
```
public int cellBytesConsumed()
```
    Description copied from interface: Cell
    
    Return the number of bytes already packed (for outgoing cells) or unpacked (for incoming cells). This is equivalent to the internal pointer position.
    
    Specified by:
    
    cellBytesConsumed in interface Cell
    
    Returns:
    
    The number of bytes already consumed from this cell.
  - cellBytesRemaining
```
public int cellBytesRemaining()
```
    Description copied from interface: Cell
    
    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.
    
    Specified by:
    
    cellBytesRemaining in interface Cell
    
    Returns:
    
    The number of payload bytes remaining in this cell.
  - putByte
```
public void putByte(int value)
```
    Description copied from interface: Cell
    
    Store a byte at the current pointer location and increment the pointer by one byte.
    
    Specified by:
    
    putByte in interface Cell
    
    Parameters:
    
    value - The byte value to store.
  - putByteAt
```
public void putByteAt(int index,
                      int value)
```
    Description copied from interface: Cell
    
    Store a byte at the specified offset into the cell.
    
    Specified by:
    
    putByteAt in interface Cell
    
    Parameters:
    
    index - The offset in bytes into the cell.
    
    value - The byte value to store.
  - putShort
```
public void putShort(int value)
```
    Description copied from interface: Cell
    
    Store a 16-bit short value in big endian order at the current pointer location and increment the pointer by two bytes.
    
    Specified by:
    
    putShort in interface Cell
    
    Parameters:
    
    value - The 16-bit short value to store.
  - putShortAt
```
public void putShortAt(int index,
                       int value)
```
    Description copied from interface: Cell
    
    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.
    
    Specified by:
    
    putShortAt in interface Cell
    
    Parameters:
    
    index - The offset in bytes into the cell.
    
    value - The 16-bit short value to store.
  - putInt
```
public void putInt(int value)
```
    Description copied from interface: Cell
    
    Store a 32-bit integer value in big endian order at the current pointer location and increment the pointer by 4 bytes.
    
    Specified by:
    
    putInt in interface Cell
    
    Parameters:
    
    value - The 32-bit integer value to store.
  - putString
```
public void putString(String string)
```
    Specified by:
    
    putString in interface Cell
  - putByteArray
```
public void putByteArray(byte[] data)
```
    Description copied from interface: Cell
    
    Store the entire array data at the current pointer location and increment the pointer by data.length bytes.
    
    Specified by:
    
    putByteArray in interface Cell
    
    Parameters:
    
    data - The array of bytes to store in the cell.
  - putByteArray
```
public void putByteArray(byte[] data,
                         int offset,
                         int length)
```
    Description copied from interface: Cell
    
    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.
    
    Specified by:
    
    putByteArray in interface Cell
    
    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
```
public byte[] getCellBytes()
```
    Description copied from interface: Cell
    
    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.
    
    Specified by:
    
    getCellBytes in interface Cell
    
    Returns:
    
    The cell data as an array of bytes.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - errorToDescription
```
public static String errorToDescription(int errorCode)
```

Class CellImpl

Field Summary

Fields inherited from interface com.subgraph.orchid.Cell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cellBuffer

Constructor Detail

CellImpl

CellImpl

Method Detail

createCell

createVarCell

readFromInputStream

getCircuitId

getCommand

resetToPayload

getByte

getByteAt

getShort

getInt

getShortAt

getByteArray

cellBytesConsumed

cellBytesRemaining

putByte

putByteAt

putShort

putShortAt

putInt

putString

putByteArray

putByteArray

getCellBytes

toString

errorToDescription