Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
All the methods associated with the socket
All the methods and events associated with the socket
Should the socket attempt to open, the following redux event is dispatched
Parameter | Description |
---|
Parameter | Description | Type | Required |
---|
type | SOCKET_OPEN |
socket | phoenix socket |
domainKey | endpoint url without socket details or protocol |
params | socket connection params |
domainUrl | socket endpoint to connect to | string |
params | optional parameters to pass when connecting to socket | any |
options | optional configuration options |
All the events associated with the socket
Should the socket attempt to disconnect, the following redux event is dispatched
Should an error occur from the phoenix socket, the following redux event is dispatched
Parameter | Description |
---|---|
Parameter | Description |
---|---|
type
SOCKET_DISCONNECT
socket
phoenix socket
domainKey
endpoint url without socket details or protocol
params
socket connection params
type
SOCKET_ERROR
error
Error response from socket
domainKey
endpoint url without socket details or protocol
socketState
Connection state of socket
Should the socket attempt to connect, the following redux event is dispatched
Parameter | Description |
---|---|
type
SOCKET_CONNECT
socket
phoenix socket
domainKey
endpoint url without socket details or protocol
Should the socket attempt to close, the following redux event is dispatched
Parameter | Description |
---|---|
type
SOCKET_CLOSE
socket
phoenix socket
domainKey
endpoint url without socket details or protocol
params
socket connection params