new BridgeEvent()
Represents an event that occurs on the event bus bridge.
Please consult the documentation for a full explanation.
- Source:
Methods
cause() → {todo}
- Source:
Returns:
- Type
- todo
complete(arg0)
Parameters:
Name | Type | Description |
---|---|---|
arg0 |
boolean |
- Source:
completer() → {function}
- Source:
Returns:
- Type
- function
compose(handler, next) → {Future}
Parameters:
Name | Type | Description |
---|---|---|
handler |
function | |
next |
Future |
- Source:
Returns:
- Type
- Future
fail(arg0)
Parameters:
Name | Type | Description |
---|---|---|
arg0 |
string |
- Source:
failed() → {boolean}
- Source:
Returns:
- Type
- boolean
getRawMessage() → {Object}
Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is
no message involved. If the returned message is modified, BridgeEvent#setRawMessage should be called with the
new message.
- Source:
Returns:
the raw JSON message for the event
- Type
- Object
isComplete() → {boolean}
- Source:
Returns:
- Type
- boolean
map(value) → {Future}
Parameters:
Name | Type | Description |
---|---|---|
value |
Object |
- Source:
Returns:
- Type
- Future
rawMessage() → {Object}
Use BridgeEvent#getRawMessage instead, will be removed in 3.3
- Source:
Returns:
- Type
- Object
result() → {boolean}
- Source:
Returns:
- Type
- boolean
setHandler(arg0) → {Future}
Parameters:
Name | Type | Description |
---|---|---|
arg0 |
function |
- Source:
Returns:
- Type
- Future
setRawMessage(message) → {BridgeEvent}
Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is
no message involved.
Parameters:
Name | Type | Description |
---|---|---|
message |
Object | the raw message |
- Source:
Returns:
this reference, so it can be used fluently
- Type
- BridgeEvent
socket() → {SockJSSocket}
Get the SockJSSocket instance corresponding to the event
- Source:
Returns:
the SockJSSocket instance
- Type
- SockJSSocket
succeeded() → {boolean}
- Source:
Returns:
- Type
- boolean
type() → {Object}
- Source:
Returns:
the type of the event
- Type
- Object