Event reference¶
To deal with sockets you need to subscribe to events you are interested in. Each event type has
Event object (or one of its children) as the callback argument. If you have symfony event
dispatcher component installed ,
the Async Socket Library’s Event object will be inherited from symfony Event object.
All events are described in EventType class.
INITIALIZE¶
- Summary
- The first event sent for each socket and can be used for some initializations, for ex. setting destination address for client socket and local address for server ones.
- Constant in
EventType - INITIALIZE
- Callback argument
Event
CONNECTED¶
- Summary
- Socket has been just connected to server.
- Constant in
EventType - CONNECTED
- Callback argument
Event
ACCEPT¶
- Summary
- Applicable only for server sockets, fires each time there is a new client, no matter what kind of transport is used tcp, udp, unix or something else. Client socket can be got from AcceptEvent.
- Constant in
EventType - INITIALIZE
- Callback argument
AcceptEvent
READ¶
- Summary
- New frame has arrived. The
Framedata object can be extracted from event object passed to the callback function. Applicable only for client sockets. - Constant in
EventType - READ
- Callback argument
ReadEvent
WRITE¶
- Summary
- Socket is ready to write data. New data must be passed to socket through event object.
- Constant in
EventType - WRITE
- Callback argument
WriteEvent
DATA_ALERT¶
- Summary
- Socket is in unmanaged state. Event is fired when
there are new data in socket, but
ReadOperationis not set. This event can be fired several times, the typical reaction should be either closing connection or setting appropriateReadOperation. If none of this is done, connection will be automatically closed andUnmanagedSocketExceptionwill be thrown. - Constant in
EventType - DATA_ALERT
- Callback argument
DataAlertEvent
DISCONNECTED¶
- Summary
- Connection to remote server is now closed. This event is not fired when socket hasn’t connected.
- Constant in
EventType - DISCONNECTED
- Callback argument
Event
FINALIZE¶
- Summary
- Socket lifecycle is complete and one can be removed from the executing engine.
- Constant in
EventType - FINALIZE
- Callback argument
Event
TIMEOUT¶
- Summary
- Socket failed to connect/read/write data during set up period of time.
- Constant in
EventType - TIMEOUT
- Callback argument
TimeoutEvent
EXCEPTION¶
- Summary
- Some
NetworkSocketExceptionoccurred and detailed information can be retrieved fromSocketExceptionEvent. - Constant in
EventType - EXCEPTION
- Callback argument
SocketExceptionEvent