CONSUMER_STATUS

<< Click to Display Table of Contents >>

Navigation:  Development > Project Artifacts >

CONSUMER_STATUS

 

The CONSUMER_STATUS collection houses real-time information on the operating status of currently running consumers (clients).

 

{

 "componentId" : "",

 "projectId" : "",

 "sessionName" : false,

 "started" : "",

 "status" : 0,

 "isAggregator" : false,

 "activeCalls" : "",

 "activeStreams" : "",

 "totalCalls" : 0,

 "totalStreams" : 0

}

 

Attribute

Value

Note

_id

A unique identifier for this status entry

 

componentId

The component identifier assigned to this consumer

 

projectName

The name of the published project this consumer targets

 

sessionName

The self-generated name of the consumer's session

Typically, this is of the form <given_name>@<hostname>

started

The time at which the consumer was registered

 

status

The current status of the consumer

 

isAggregator

A flag that says if this status entry is for a regular client, or for an aggregator's client.

 

activeCalls

The number of remote calls currently being accessed

 

activeStreams

The number of streams currently being accessed

 

totalCalls

The total number of calls the consumer has accessed

 

totalStreams

The total number of streams the consumer has accesssed