# Class: BridgeEvent

## vertx-tcp-eventbus-bridge-js/bridge_event~ BridgeEvent

#### new BridgeEvent()

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 34

### Methods

#### cause() → {todo}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 150

##### Returns:

Type
  todo

#### complete(arg0)

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | boolean |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 78

#### completer() → {function}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 241

##### Returns:

Type
  function

#### compose(handler, next) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |
`next` | Future |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 190

##### Returns:

Type
  Future

#### fail(arg0)

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | string |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 92

#### failed() → {boolean}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 176

##### Returns:

Type
  boolean

#### getRawMessage() → {Object}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 320

##### Returns:

Type
  Object

#### isComplete() → {boolean}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 46

##### Returns:

Type
  boolean

#### map(value) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`value` | Object |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 210

##### Returns:

Type
  Future

#### mapEmpty() → {Future}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 228

##### Returns:

Type
  Future

#### otherwise(value) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`value` | boolean |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 273

##### Returns:

Type
  Future

#### otherwiseEmpty() → {Future}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 291

##### Returns:

Type
  Future

#### recover(mapper) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`mapper` | todo |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 257

##### Returns:

Type
  Future

#### result() → {boolean}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 137

##### Returns:

Type
  boolean

#### setHandler(arg0) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | function |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 59

##### 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:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 335

##### Returns:

this reference, so it can be used fluently

Type
  BridgeEvent

#### socket() → {NetSocket}

Get the SockJSSocket instance corresponding to the event

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 350

##### Returns:

the SockJSSocket instance

Type
  NetSocket

#### succeeded() → {boolean}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 163

##### Returns:

Type
  boolean

#### tryComplete(arg0) → {boolean}

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | boolean |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 107

##### Returns:

Type
  boolean

#### tryFail(arg0) → {boolean}

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | string |

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 122

##### Returns:

Type
  boolean

#### type() → {Object}

Source:
  - vertx-tcp-eventbus-bridge-js/bridge_event.js, line 304

##### Returns:

Type
  Object