Web Socket API

Request example:

{
	"q": "someQualifier",
	"sid": 1,
	"d": {
		"key": "value"
	}
}

where:

Param	Required	Description
q	Required	qulifier to identify an entrypooint
sid	Required	stream identifier
d	Required	request data
sig	Optional	3 value means cancel running, no responses after given such type of response for the given stream ID

Response example:

{
	"q": "/qualifier/req-resp",
	"sid": 1,
	"d": {
		"key": "value"
	}
}

and then followed the relevant stream complete signal:

{
        "q": "/qualifier/req-resp",
	"sid": 1,
	"sig": 1
}

where:

Param	Required	Description
q	Required	qualifier to identify an entry point
sid	Required	stream identifier
sig	Optional	completion signal, no responses after given such type of response for the given stream ID
d	Optional	response data, except for completion response

Response structure regarding the relevant stream behaviour:

• "sig":1 - Stream signal successfully completed
• "sig":2 - Stream signal error occurred
• "sig":3 - Stream signal cancelled

To unsubscribe you can send the cancel request like the following:

{
        "q": "/qualifier/req-resp",
	"sid": 1,
	"sig": 3
}

where you need to specify the correct qualifier, sid and also the mentioned cancel signal ("sig": 3).