The configuration constructor is passed a configuration service instance
Methods
(async) close_client(client)
Called when a client is closed
Parameters:
| Name | Type | Description |
|---|---|---|
client |
hyrrokkin_engine.ClientInterface | an instance providing methods to send and receive messages |
close_session(session_id)
Called when a session is closed
Parameters:
| Name | Type | Description |
|---|---|---|
session_id |
string | identify the session being closed |
(async) create_node(node_type_id, service) → {Promise.<*>}
Create a node which is defined within this package
Parameters:
| Name | Type | Description |
|---|---|---|
node_type_id |
string | the id of the node type (a valid key in the schema's node_types dictionary) |
service |
hyrrokkin_engine.NodeServiceInterface | a service instance which will provide services to the node |
Returns:
- Type
- Promise.<*>
(async) decode(encoded_bytes, link_type) → {*}
Decode binary data into a value valid for a particular link type
Parameters:
| Name | Type | Description |
|---|---|---|
encoded_bytes |
ArrayBuffer | binary data to decode |
link_type |
string | the link type associated with the value |
Returns:
- Type
- *
(async) encode(value, link_type) → {ArrayBuffer}
Encode a value associated with a link type to binary data
Parameters:
| Name | Type | Description |
|---|---|---|
value |
* | the value to encode |
link_type |
string | the link type associated with the value |
Returns:
- Type
- ArrayBuffer
(async) load() → {Promise.<void>}
Called after construction. Load any resources associated with this Configuration
Returns:
- Type
- Promise.<void>
(async) open_client(client)
Called when a client is opened
Parameters:
| Name | Type | Description |
|---|---|---|
client |
hyrrokkin_engine.ClientInterface | an instance providing methods to send and receive messages |
open_session(session_id)
Called when a session is opened
Parameters:
| Name | Type | Description |
|---|---|---|
session_id |
string | identify the session being opened |