Events (nadron 0.4.1 API)

java.lang.Object
- io.nadron.event.Events

```
public class Events
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`ANY` Events should NEVER have this type.
`static byte`	`CHANGE_ATTRIBUTE`
`static byte`	`CONNECT`
`static byte`	`CONNECT_FAILED`
`static byte`	`DISCONNECT` If a remote connection is disconnected or closed then raise this event.
`static byte`	`EXCEPTION` A network exception will in turn cause this even to be raised.
`static byte`	`GAME_LIST`
`static byte`	`GAME_ROOM_JOIN`
`static byte`	`GAME_ROOM_JOIN_FAILURE`
`static byte`	`GAME_ROOM_JOIN_SUCCESS`
`static byte`	`GAME_ROOM_LEAVE`
`static byte`	`LOG_IN` Event used to log in to a server from a remote client.
`static byte`	`LOG_IN_FAILURE`
`static byte`	`LOG_IN_SUCCESS`
`static byte`	`LOG_OUT`
`static byte`	`LOG_OUT_FAILURE`
`static byte`	`LOG_OUT_SUCCESS`
`static byte`	`NETWORK_MESSAGE` This event is used to send data from the current machine to remote machines using TCP or UDP transports.
`static byte`	`PROTCOL_VERSION`
`static byte`	`RECONNECT` Similar to LOG_IN but parameters are different.
`static byte`	`ROOM_LIST`
`static byte`	`SESSION_MESSAGE` Incoming data from another machine/JVM to this JVM (server or client)
`static byte`	`START` Event sent from server to client to start message sending from client to server.
`static byte`	`STOP` Event sent from server to client to stop messages from being sent to server.

Constructor Summary

Constructors
Constructor and Description

Events()

Constructors
Constructor and Description
`Events()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Event`	`changeAttributeEvent(String key, Object value)`
`static Event`	`connectEvent(MessageSender.Fast udpSender)`
`static Event`	`connectEvent(MessageSender.Reliable tcpSender)`
`static Event`	`connectEvent(MessageSender.Reliable tcpSender, MessageSender.Fast udpSender)`
`static Event`	`dataInEvent(Object source)`
`static Event`	`event(Object source, int eventType)`
`static Event`	`event(Object source, int eventType, EventContext context)`
`static Event`	`event(Object source, int eventType, Session session)`
`static NetworkEvent`	`networkEvent(Object source)` Creates a network event with the source set to the object passed in as parameter and the `DeliveryGuaranty` set to `DeliveryGuaranty.DeliveryGuarantyOptions.RELIABLE`.
`static NetworkEvent`	`networkEvent(Object source, DeliveryGuaranty deliveryGuaranty)` Creates a network event with the source set to the object passed in as parameter and the `DeliveryGuaranty` set to the incoming parameter.

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

- Field Detail
  - PROTCOL_VERSION
```
public static final byte PROTCOL_VERSION
```
    See Also:
    Constant Field Values
  - ANY
```
public static final byte ANY
```
    Events should NEVER have this type. But event handlers can choose to have this type to signify that they will handle any type of incoming event. For e.g. DefaultSessionEventHandler
    
    See Also:
    Constant Field Values
  - CONNECT
```
public static final byte CONNECT
```
    See Also:
    Constant Field Values
  - RECONNECT
```
public static final byte RECONNECT
```
    Similar to LOG_IN but parameters are different. This event is sent from client to server.
    
    See Also:
    Constant Field Values
  - CONNECT_FAILED
```
public static final byte CONNECT_FAILED
```
    See Also:
    Constant Field Values
  - LOG_IN
```
public static final byte LOG_IN
```
    Event used to log in to a server from a remote client. Example payload will be login opcode 0x08-protocl version 0x01- username as string bytes- password as string bytes - connection key as string bytes - optional udp client address as bytes
    
    See Also:
    Constant Field Values
  - LOG_OUT
```
public static final byte LOG_OUT
```
    See Also:
    Constant Field Values
  - LOG_IN_SUCCESS
```
public static final byte LOG_IN_SUCCESS
```
    See Also:
    Constant Field Values
  - LOG_IN_FAILURE
```
public static final byte LOG_IN_FAILURE
```
    See Also:
    Constant Field Values
  - LOG_OUT_SUCCESS
```
public static final byte LOG_OUT_SUCCESS
```
    See Also:
    Constant Field Values
  - LOG_OUT_FAILURE
```
public static final byte LOG_OUT_FAILURE
```
    See Also:
    Constant Field Values
  - GAME_LIST
```
public static final byte GAME_LIST
```
    See Also:
    Constant Field Values
  - ROOM_LIST
```
public static final byte ROOM_LIST
```
    See Also:
    Constant Field Values
  - GAME_ROOM_JOIN
```
public static final byte GAME_ROOM_JOIN
```
    See Also:
    Constant Field Values
  - GAME_ROOM_LEAVE
```
public static final byte GAME_ROOM_LEAVE
```
    See Also:
    Constant Field Values
  - GAME_ROOM_JOIN_SUCCESS
```
public static final byte GAME_ROOM_JOIN_SUCCESS
```
    See Also:
    Constant Field Values
  - GAME_ROOM_JOIN_FAILURE
```
public static final byte GAME_ROOM_JOIN_FAILURE
```
    See Also:
    Constant Field Values
  - START
```
public static final byte START
```
    Event sent from server to client to start message sending from client to server.
    
    See Also:
    Constant Field Values
  - STOP
```
public static final byte STOP
```
    Event sent from server to client to stop messages from being sent to server.
    
    See Also:
    Constant Field Values
  - SESSION_MESSAGE
```
public static final byte SESSION_MESSAGE
```
    Incoming data from another machine/JVM to this JVM (server or client)
    
    See Also:
    Constant Field Values
  - NETWORK_MESSAGE
```
public static final byte NETWORK_MESSAGE
```
    This event is used to send data from the current machine to remote machines using TCP or UDP transports. It is an out-going event.
    
    See Also:
    Constant Field Values
  - CHANGE_ATTRIBUTE
```
public static final byte CHANGE_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - DISCONNECT
```
public static final byte DISCONNECT
```
    If a remote connection is disconnected or closed then raise this event.
    
    See Also:
    Constant Field Values
  - EXCEPTION
```
public static final byte EXCEPTION
```
    A network exception will in turn cause this even to be raised.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Events
```
public Events()
```
- Method Detail
  - event
```
public static Event event(Object source,
          int eventType)
```
  - event
```
public static Event event(Object source,
          int eventType,
          Session session)
```
  - event
```
public static Event event(Object source,
          int eventType,
          EventContext context)
```
  - networkEvent
```
public static NetworkEvent networkEvent(Object source)
```
    Creates a network event with the source set to the object passed in as parameter and the DeliveryGuaranty set to DeliveryGuaranty.DeliveryGuarantyOptions.RELIABLE. This method delegates to networkEvent(Object, DeliveryGuaranty).
    
    Parameters:
    source - The payload of the event. This is the actual data that gets transmitted to remote machine.
    
    Returns:
    An instance of NetworkEvent
  - networkEvent
```
public static NetworkEvent networkEvent(Object source,
                        DeliveryGuaranty deliveryGuaranty)
```
    Creates a network event with the source set to the object passed in as parameter and the DeliveryGuaranty set to the incoming parameter.
    
    Parameters:
    source - The payload of the event. This is the actual data that gets transmitted to remote machine.
    deliveryGuaranty - This decides which transport TCP or UDP to be used to send the message to remote machine.
    
    Returns:
    An instance of NetworkEvent
  - connectEvent
```
public static Event connectEvent(MessageSender.Reliable tcpSender)
```
  - connectEvent
```
public static Event connectEvent(MessageSender.Fast udpSender)
```
  - connectEvent
```
public static Event connectEvent(MessageSender.Reliable tcpSender,
                 MessageSender.Fast udpSender)
```
  - dataInEvent
```
public static Event dataInEvent(Object source)
```
  - changeAttributeEvent
```
public static Event changeAttributeEvent(String key,
                         Object value)
```

Class Events

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTCOL_VERSION

ANY

CONNECT

RECONNECT

CONNECT_FAILED

LOG_IN

LOG_OUT

LOG_IN_SUCCESS

LOG_IN_FAILURE

LOG_OUT_SUCCESS

LOG_OUT_FAILURE

GAME_LIST

ROOM_LIST

GAME_ROOM_JOIN

GAME_ROOM_LEAVE

GAME_ROOM_JOIN_SUCCESS

GAME_ROOM_JOIN_FAILURE

START

STOP

SESSION_MESSAGE

NETWORK_MESSAGE

CHANGE_ATTRIBUTE

DISCONNECT

EXCEPTION

Constructor Detail

Events

Method Detail

event

event

event

networkEvent

networkEvent

connectEvent

connectEvent

connectEvent

dataInEvent

changeAttributeEvent