SessionStatusMessage (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.data.DataStructureImpl
- - net.i2p.data.i2cp.I2CPMessageImpl
  - - net.i2p.data.i2cp.SessionStatusMessage

All Implemented Interfaces:

Serializable, DataStructure, I2CPMessage
```
public class SessionStatusMessage
extends I2CPMessageImpl
```
Defines the message a router sends to a client indicating the status of the session.

Author:

jrandom

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`MESSAGE_TYPE`
`static int`	`STATUS_CREATED`
`static int`	`STATUS_DESTROYED`
`static int`	`STATUS_INVALID`
`static int`	`STATUS_REFUSED`
`static int`	`STATUS_UPDATED`

Constructor Summary

Constructors
Constructor Description

SessionStatusMessage()

Constructors
Constructor	Description
`SessionStatusMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doReadMessage(InputStream in, int size)`	Read in the payload part of the message (after the initial 4 byte size and 1 byte type)
`protected byte[]`	`doWriteMessage()`	Write out the payload part of the message (not including the 4 byte size and 1 byte type)
`SessionId`	`getSessionId()`
`int`	`getStatus()`
`int`	`getType()`	Return the unique identifier for this type of message, as specified in the network specification document under #ClientAccessLayerMessages
`SessionId`	`sessionId()`	Return the SessionId for this message.
`void`	`setSessionId(SessionId id)`
`void`	`setStatus(int status)`
`String`	`toString()`

Methods inherited from interface net.i2p.data.DataStructure
calculateHash, fromBase64, fromByteArray, toBase64, toByteArray

Methods inherited from class net.i2p.data.DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64, toByteArray

Methods inherited from class net.i2p.data.i2cp.I2CPMessageImpl
readBytes, readMessage, readMessage, writeBytes, writeMessage

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

- Field Detail
  - MESSAGE_TYPE
```
public static final int MESSAGE_TYPE
```
    See Also:
    
    Constant Field Values
  - STATUS_DESTROYED
```
public static final int STATUS_DESTROYED
```
    See Also:
    
    Constant Field Values
  - STATUS_CREATED
```
public static final int STATUS_CREATED
```
    See Also:
    
    Constant Field Values
  - STATUS_UPDATED
```
public static final int STATUS_UPDATED
```
    See Also:
    
    Constant Field Values
  - STATUS_INVALID
```
public static final int STATUS_INVALID
```
    See Also:
    
    Constant Field Values
  - STATUS_REFUSED
```
public static final int STATUS_REFUSED
```
    Since:
    
    0.9.12
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SessionStatusMessage
```
public SessionStatusMessage()
```
- Method Detail
  - getSessionId
```
public SessionId getSessionId()
```
  - sessionId
```
public SessionId sessionId()
```
    Return the SessionId for this message.
    
    Specified by:
    
    sessionId in interface I2CPMessage
    
    Overrides:
    
    sessionId in class I2CPMessageImpl
    
    Returns:
    
    null always. Extending classes with a SessionId must override.
    
    Since:
    
    0.9.21
  - setSessionId
```
public void setSessionId(SessionId id)
```
  - getStatus
```
public int getStatus()
```
  - setStatus
```
public void setStatus(int status)
```
  - doReadMessage
```
protected void doReadMessage(InputStream in,
                             int size)
                      throws I2CPMessageException,
                             IOException
```
    Description copied from class: I2CPMessageImpl
    
    Read in the payload part of the message (after the initial 4 byte size and 1 byte type)
    
    Specified by:
    
    doReadMessage in class I2CPMessageImpl
    
    Parameters:
    
    in - InputStream
    
    size - payload size
    
    Throws:
    
    I2CPMessageException
    
    IOException
  - doWriteMessage
```
protected byte[] doWriteMessage()
                         throws I2CPMessageException,
                                IOException
```
    Description copied from class: I2CPMessageImpl
    
    Write out the payload part of the message (not including the 4 byte size and 1 byte type)
    
    Specified by:
    
    doWriteMessage in class I2CPMessageImpl
    
    Returns:
    
    byte array
    
    Throws:
    
    I2CPMessageException
    
    IOException
  - getType
```
public int getType()
```
    Description copied from interface: I2CPMessage
    
    Return the unique identifier for this type of message, as specified in the network specification document under #ClientAccessLayerMessages
    
    Returns:
    
    unique identifier for this type of message
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionStatusMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface net.i2p.data.DataStructure

Methods inherited from class net.i2p.data.DataStructureImpl

Methods inherited from class net.i2p.data.i2cp.I2CPMessageImpl

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE

STATUS_DESTROYED

STATUS_CREATED

STATUS_UPDATED

STATUS_INVALID

STATUS_REFUSED

Constructor Detail

SessionStatusMessage

Method Detail

getSessionId

sessionId

setSessionId

getStatus

setStatus

doReadMessage

doWriteMessage

getType

toString