Class: Message

jmp~Message(propertiesopt)

new Message(propertiesopt)

Jupyter message
Parameters:
Name Type Attributes Description
properties <optional>
 Message properties
Properties
Name Type Attributes Description
idents Array <optional>
 ZMQ identities
header Object <optional>
parent_header Object <optional>
metadata Object <optional>
content Object <optional>
buffers Array <optional>
 Unparsed message frames
Source:

Members

buffers :Array

Unparsed JMP message frames (any frames after content)
Type:
  • Array
Source:

content :Object

Type:
  • Object
Source:
Type:
  • Object
Source:

idents :Array

ZMQ identities
Type:
  • Array
Source:

metadata :Object

Type:
  • Object
Source:

parent_header :Object

Type:
  • Object
Source:

Methods

(protected, static) _decode(messageFrames, schemeopt, keyopt) → (nullable) {module:jmp~Message}

Decode message received over a ZMQ socket
Parameters:
Name Type Attributes Default Description
messageFrames argsArray argsArray of a message listener on a JMP socket
scheme String <optional>
 sha256 Hashing scheme
key String <optional>
 "" Hashing key
Source:
Returns:
JMP message or `null` if failed to decode
Type
module:jmp~Message

(protected) _encode(schemeopt, keyopt) → {Array}

Encode message for transfer over a ZMQ socket
Parameters:
Name Type Attributes Default Description
scheme String <optional>
 sha256 Hashing scheme
key String <optional>
 "" Hashing key
Source:
Returns:
Encoded message
Type
Array

respond(socket, messageType, contentopt, metadataopt, protocolVersionopt) → {module:jmp~Message}

Send a response over a given socket
Parameters:
Name Type Attributes Description
socket module:zmq~Socket Socket over which the response is sent
messageType String Jupyter response message type
content Object <optional>
 Jupyter response content
metadata Object <optional>
 Jupyter response metadata
protocolVersion String <optional>
 Jupyter protocol version
Source:
Returns:
The response message sent over the given socket
Type
module:jmp~Message