Transaction

flitter-socket/Transaction~ Transaction

Object representing one exchange between two parties in a websocket connection. Handles response sending and request data.

Constructor

new Transaction()

Source:

Members

(private) _message :string

Message to be included in the response. User this.message() to get/set.

Type:
  • string
Source:

(private) _status :number

HTTP-equivalent status code for this transaction. Use this.status() to get/set.

Type:
  • number
Source:

cm :module:flitter-socket/ConnectionManager~ConnectionManager

The connection manager that spawned this transaction.

Type:
Source:

connection_id :string

Unique ID of the websocket client's connection in the connection manager.

Type:
  • string
Source:

id :string

Universally-unique id of this transaction. Used by both parties to match up requests and responses.

Type:
  • string
Source:

incoming :Object

Contains the incoming data for the transaction. That is, the data from the sender.

Type:
  • Object
Source:

outgoing :Object

Contains the outgoing data for the transaction. That is, the data sent/to be sent back to the sender.

Type:
  • Object
Source:

received :boolean

Set to true if 1. the transaction was awaiting data and 2. the data has been received

Type:
  • boolean
Source:

resolved :boolean

Whether the transaction has completed. That is, has the recipient sent a response.

Type:
  • boolean
Source:

sent :boolean

Set to true if 1. this transaction is a response and 2. the response has been sent

Type:
  • boolean
Source:

socket :Socket

The open websocket used for communication

Type:
  • Socket
Source:

type :"request"|"response"

Is this a request or a response-type transaction?

Type:
  • "request" | "response"
Source:

Methods

message(msgopt) → {Transaction|string}

Get or set the message. If a new message is provided, set the message and return this for chaining. Otherwise get the current message.

Parameters:
Name Type Attributes Default Description
msg string <optional>
 null
Source:
Returns:
  • if message is provided, set the message and return this; otherwise return the current message
Type
Transaction | string

resolve()

Mark the transaction as resolved.

Source:

send(data) → {*|boolean|void}

Send data to the recipient of this transaction as stringified JSON, and resolve the transaction.

Parameters:
Name Type Description
data
Source:
Returns:
Type
* | boolean | void

status(codeopt) → {Transaction|number}

Get or set the status code. If a new code is provided, set the status code and return this for chaining. Otherwise, get the current status code.

Parameters:
Name Type Attributes Default Description
code number <optional>
 null
Source:
Returns:
  • if code is provided, set the code and return this; otherwise return the current code
Type
Transaction | number