EzySession (ezyfox-server-core 1.1.9 API)

All Superinterfaces:

EzyDeliver, com.tvd12.ezyfox.util.EzyDestroyable, com.tvd12.ezyfox.constant.EzyHasName, com.tvd12.ezyfox.util.EzyProperties, com.tvd12.ezyfox.util.EzyRoProperties, Serializable

All Known Implementing Classes:

EzyAbstractSession
```
public interface EzySession
extends EzyDeliver, com.tvd12.ezyfox.constant.EzyHasName, com.tvd12.ezyfox.util.EzyProperties, com.tvd12.ezyfox.util.EzyDestroyable, Serializable
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addReadBytes(long bytes)` Add read bytes
`void`	`addReadRequests(int requests)` add read requests
`boolean`	`addReceviedRequests(int requests)` add received requests
`void`	`addWrittenBytes(long bytes)` Add written bytes
`void`	`addWrittenResponses(int responses)` add written responses
`void`	`close()` close this session
`default void`	`disconnect()` disconnect
`void`	`disconnect(com.tvd12.ezyfox.constant.EzyConstant reason)` disconnect this session
`String`	`getBeforeToken()` Get before reconnect token
`EzyChannel`	`getChannel()` Get the channel mapped to this session
`SocketAddress`	`getClientAddress()` Get client full ip address
`String`	`getClientId()` Get client id
`byte[]`	`getClientKey()` Get client key to encrypt data send to client
`String`	`getClientType()` Get client type
`String`	`getClientVersion()` Get client version
`<T> T`	`getConnection()` Get connection
`com.tvd12.ezyfox.constant.EzyConstant`	`getConnectionType()` Get session connection type
`long`	`getCreationTime()` Get creation time in long
`DatagramChannel`	`getDatagramChannel()` Get upd channel
`EzyDatagramChannelPool`	`getDatagramChannelPool()` Get datagram channel pool
`com.tvd12.ezyfox.constant.EzyConstant`	`getDisconnectReason()`
`EzyRequestQueue`	`getExtensionRequestQueue()` Get extension request queue
`long`	`getId()` Get session id
`long`	`getLastActivityTime()` Get last activity time in long
`long`	`getLastReadTime()` Get last read time in long
`long`	`getLastWriteTime()` Get last write time in long
`Lock`	`getLock(String name)`
`long`	`getLoggedInTime()`
`long`	`getMaxIdleTime()` Get max idle time
`long`	`getMaxWaitingTime()`
`String`	`getOwnerName()`
`EzyPacketQueue`	`getPacketQueue()` Get packet queue
`byte[]`	`getPrivateKey()` Get private key
`byte[]`	`getPublicKey()` Get public key
`long`	`getReadBytes()` Get read bytes
`int`	`getReadRequests()` Get read requests
`SocketAddress`	`getServerAddress()` Get server full ip address
`byte[]`	`getSessionKey()` Get session key to encrypt data send to client
`EzyRequestQueue`	`getSystemRequestQueue()` Get system request queue
`String`	`getToken()` Get session reconnect token
`SocketAddress`	`getUdpClientAddress()` Get udp client address
`long`	`getWrittenBytes()` Get written bytes
`int`	`getWrittenResponses()` Get written responses
`boolean`	`isActivated()`
`boolean`	`isDestroyed()`
`boolean`	`isIdle()`
`boolean`	`isLoggedIn()`
`boolean`	`isStreamingEnable()`
`void`	`setActivated(boolean activated)`
`void`	`setChannel(EzyChannel channel)` Map this session to the channel
`void`	`setClientId(String id)` Set client id
`void`	`setClientKey(byte[] key)` Set client key
`void`	`setClientType(String type)` Set client type
`void`	`setClientVersion(String version)` Set client version
`void`	`setCreationTime(long time)` Set creation time
`void`	`setLastActivityTime(long time)` Set last activity time
`void`	`setLastReadTime(long time)` Set last read time
`void`	`setLastWriteTime(long time)` Set last write time
`void`	`setLoggedIn(boolean value)` Set logged in or not
`void`	`setLoggedInTime(long time)`
`void`	`setMaxIdleTime(long time)`
`void`	`setMaxWaitingTime(long time)`
`void`	`setPrivateKey(byte[] key)` The private key that decrypt data
`void`	`setPublicKey(byte[] key)` Set public key that encrypt data
`void`	`setSessionKey(byte[] key)` Set session key
`void`	`setToken(String token)` Set reconnect token

Methods inherited from interface com.tvd12.ezyfoxserver.entity.EzyDeliver
send, sendNow

Methods inherited from interface com.tvd12.ezyfox.constant.EzyHasName
getName

Methods inherited from interface com.tvd12.ezyfox.util.EzyProperties
removeProperty, setProperties, setProperty

Methods inherited from interface com.tvd12.ezyfox.util.EzyRoProperties
containsKey, getProperties, getProperty, getProperty, getProperty

Methods inherited from interface com.tvd12.ezyfox.util.EzyDestroyable
destroy

- Method Detail
  - getId
```
long getId()
```
    Get session id
    
    Returns:
    
    the session id
  - getClientId
```
String getClientId()
```
    Get client id
    
    Returns:
    
    the client id
  - setClientId
```
void setClientId(String id)
```
    Set client id
    
    Parameters:
    
    id - the client id
  - getClientKey
```
byte[] getClientKey()
```
    Get client key to encrypt data send to client
    
    Returns:
    
    the client key
  - setClientKey
```
void setClientKey(byte[] key)
```
    Set client key
    
    Parameters:
    
    key - the client key
  - setSessionKey
```
void setSessionKey(byte[] key)
```
    Set session key
    
    Parameters:
    
    key - the session key
  - getSessionKey
```
byte[] getSessionKey()
```
    Get session key to encrypt data send to client
    
    Returns:
    
    the session key
  - getClientType
```
String getClientType()
```
    Get client type
    
    Returns:
    
    the client type
  - setClientType
```
void setClientType(String type)
```
    Set client type
    
    Parameters:
    
    type - the client type
  - getClientVersion
```
String getClientVersion()
```
    Get client version
    
    Returns:
    
    the client version
  - setClientVersion
```
void setClientVersion(String version)
```
    Set client version
    
    Parameters:
    
    version - the client version
  - getConnectionType
```
com.tvd12.ezyfox.constant.EzyConstant getConnectionType()
```
    Get session connection type
    
    Returns:
    
    the connection type
  - getToken
```
String getToken()
```
    Get session reconnect token
    
    Returns:
    
    the session reconnect token
  - getBeforeToken
```
String getBeforeToken()
```
    Get before reconnect token
    
    Returns:
    
    before reconnect token
  - setToken
```
void setToken(String token)
```
    Set reconnect token
    
    Parameters:
    
    token - the reconnect token
  - setPrivateKey
```
void setPrivateKey(byte[] key)
```
    The private key that decrypt data
    
    Parameters:
    
    key - the key
  - getPrivateKey
```
byte[] getPrivateKey()
```
    Get private key
    
    Returns:
    
    the private key
  - setPublicKey
```
void setPublicKey(byte[] key)
```
    Set public key that encrypt data
    
    Parameters:
    
    key - the public key
  - getPublicKey
```
byte[] getPublicKey()
```
    Get public key
    
    Returns:
    
    the public key
  - getCreationTime
```
long getCreationTime()
```
    Get creation time in long
    
    Returns:
    
    the creation time
  - setCreationTime
```
void setCreationTime(long time)
```
    Set creation time
    
    Parameters:
    
    time - the creation time
  - getLastActivityTime
```
long getLastActivityTime()
```
    Get last activity time in long
    
    Returns:
    
    the last activity time
  - setLastActivityTime
```
void setLastActivityTime(long time)
```
    Set last activity time
    
    Parameters:
    
    time - the last activity time
  - getLastReadTime
```
long getLastReadTime()
```
    Get last read time in long
    
    Returns:
    
    the last read time
  - setLastReadTime
```
void setLastReadTime(long time)
```
    Set last read time
    
    Parameters:
    
    time - the last read time
  - getLastWriteTime
```
long getLastWriteTime()
```
    Get last write time in long
    
    Returns:
    
    the last read time
  - setLastWriteTime
```
void setLastWriteTime(long time)
```
    Set last write time
    
    Parameters:
    
    time - the last read time
  - getReadBytes
```
long getReadBytes()
```
    Get read bytes
    
    Returns:
    
    the read bytes
  - addReadBytes
```
void addReadBytes(long bytes)
```
    Add read bytes
    
    Parameters:
    
    bytes - the read bytes
  - getWrittenBytes
```
long getWrittenBytes()
```
    Get written bytes
    
    Returns:
    
    the written bytes
  - addWrittenBytes
```
void addWrittenBytes(long bytes)
```
    Add written bytes
    
    Parameters:
    
    bytes - the written bytes
  - getReadRequests
```
int getReadRequests()
```
    Get read requests
    
    Returns:
    
    the number of read request
  - addReadRequests
```
void addReadRequests(int requests)
```
    add read requests
    
    Parameters:
    
    requests - number of read requests
  - addReceviedRequests
```
boolean addReceviedRequests(int requests)
```
    add received requests
    
    Parameters:
    
    requests - number of received requests
    
    Returns:
    
    max request per second or not
  - getWrittenResponses
```
int getWrittenResponses()
```
    Get written responses
    
    Returns:
    
    number of written responses
  - addWrittenResponses
```
void addWrittenResponses(int responses)
```
    add written responses
    
    Parameters:
    
    responses - number of responses
  - getMaxIdleTime
```
long getMaxIdleTime()
```
    Get max idle time
    
    Returns:
    
    the max idle time
  - setMaxIdleTime
```
void setMaxIdleTime(long time)
```
    Parameters:
    
    time - the max idle time
  - setLoggedIn
```
void setLoggedIn(boolean value)
```
    Set logged in or not
    
    Parameters:
    
    value - logged in or not
  - isLoggedIn
```
boolean isLoggedIn()
```
    Returns:
    
    true of user has logged in
  - setLoggedInTime
```
void setLoggedInTime(long time)
```
    Parameters:
    
    time - the logged time
  - getLoggedInTime
```
long getLoggedInTime()
```
    Returns:
    
    the logged in time
  - setMaxWaitingTime
```
void setMaxWaitingTime(long time)
```
    Parameters:
    
    time - the max waiting for user login time
  - getMaxWaitingTime
```
long getMaxWaitingTime()
```
    Returns:
    
    time the max waiting for user login time
  - setActivated
```
void setActivated(boolean activated)
```
    Parameters:
    
    activated - session is active or not
  - isActivated
```
boolean isActivated()
```
    Returns:
    
    session is active or not
  - isIdle
```
boolean isIdle()
```
    Returns:
    
    session is idle or not
  - isDestroyed
```
boolean isDestroyed()
```
    Returns:
    
    destroyed or not
  - isStreamingEnable
```
boolean isStreamingEnable()
```
    Returns:
    
    streaming enable or not
  - getOwnerName
```
String getOwnerName()
```
    Returns:
    
    the owner name
  - getDisconnectReason
```
com.tvd12.ezyfox.constant.EzyConstant getDisconnectReason()
```
    Returns:
    
    the disconnect reason
  - getLock
```
Lock getLock(String name)
```
    Parameters:
    
    name - the lock name
    
    Returns:
    
    the lock
  - getClientAddress
```
SocketAddress getClientAddress()
```
    Get client full ip address
    
    Returns:
    
    the client full ip address
  - getServerAddress
```
SocketAddress getServerAddress()
```
    Get server full ip address
    
    Returns:
    
    the server full ip address
  - close
```
void close()
```
    close this session
  - disconnect
```
void disconnect(com.tvd12.ezyfox.constant.EzyConstant reason)
```
    disconnect this session
    
    Parameters:
    
    reason - the reason
  - getChannel
```
EzyChannel getChannel()
```
    Get the channel mapped to this session
    
    Returns:
    
    the channel
  - setChannel
```
void setChannel(EzyChannel channel)
```
    Map this session to the channel
    
    Parameters:
    
    channel - the channel
  - getConnection
```
<T> T getConnection()
```
    Get connection
    
    Type Parameters:
    
    T - the connection type
    
    Returns:
    
    the connection
  - getPacketQueue
```
EzyPacketQueue getPacketQueue()
```
    Get packet queue
    
    Returns:
    
    the packet queue
  - getSystemRequestQueue
```
EzyRequestQueue getSystemRequestQueue()
```
    Get system request queue
    
    Returns:
    
    the system request queue
  - getExtensionRequestQueue
```
EzyRequestQueue getExtensionRequestQueue()
```
    Get extension request queue
    
    Returns:
    
    the extension request queue
  - getUdpClientAddress
```
SocketAddress getUdpClientAddress()
```
    Get udp client address
    
    Returns:
    
    the udp client address
  - getDatagramChannel
```
DatagramChannel getDatagramChannel()
```
    Get upd channel
    
    Returns:
    
    the udp channel
  - getDatagramChannelPool
```
EzyDatagramChannelPool getDatagramChannelPool()
```
    Get datagram channel pool
    
    Returns:
    
    the datagram channel pool
  - disconnect
```
default void disconnect()
```
    disconnect

Interface EzySession

Method Summary

Methods inherited from interface com.tvd12.ezyfoxserver.entity.EzyDeliver

Methods inherited from interface com.tvd12.ezyfox.constant.EzyHasName

Methods inherited from interface com.tvd12.ezyfox.util.EzyProperties

Methods inherited from interface com.tvd12.ezyfox.util.EzyRoProperties

Methods inherited from interface com.tvd12.ezyfox.util.EzyDestroyable

Method Detail

getId

getClientId

setClientId

getClientKey

setClientKey

setSessionKey

getSessionKey

getClientType

setClientType

getClientVersion

setClientVersion

getConnectionType

getToken

getBeforeToken

setToken

setPrivateKey

getPrivateKey

setPublicKey

getPublicKey

getCreationTime

setCreationTime

getLastActivityTime

setLastActivityTime

getLastReadTime

setLastReadTime

getLastWriteTime

setLastWriteTime

getReadBytes

addReadBytes

getWrittenBytes

addWrittenBytes

getReadRequests

addReadRequests

addReceviedRequests

getWrittenResponses

addWrittenResponses

getMaxIdleTime

setMaxIdleTime

setLoggedIn

isLoggedIn

setLoggedInTime

getLoggedInTime

setMaxWaitingTime

getMaxWaitingTime

setActivated

isActivated

isIdle

isDestroyed

isStreamingEnable

getOwnerName

getDisconnectReason

getLock

getClientAddress

getServerAddress

close

disconnect

getChannel

setChannel

getConnection

getPacketQueue

getSystemRequestQueue

getExtensionRequestQueue

getUdpClientAddress

getDatagramChannel

getDatagramChannelPool

disconnect