StreamMBean (Lightstreamer JMX MBeans 5.8.1)

```
public interface StreamMBean
```
One StreamMBean instance exists in the system, to provide information related to the data push activity of the Server. It is created at startup by Lightstreamer Server and lasts until the shutdown of the Server.

The main services provided by this MBean are:
- Statistics about update events received from the Data Adapters, i.e. "inbound" events (like getCumulInboundEvents()).
- Statistics about "inbound" update events as transformed by the optional handling by the Preprocessor, i.e. "PreProc outbound" events like getOutboundPreprocEventFrequency()).
- Statistics about update events sent to the clients, i.e. "item updates", cumulated on all sessions (like getCumulItemUpdates()).
- Statistics about network throughput (here also named "bandwidth") due to the update events sent to the clients (like getMaxBandwidthKbps()).
- Statistics about update events due to be sent to the clients but not sent, as conflated (i.e. "filtered") or lost for overflow (like getNewFilteredEvents()).
- Statistics about messages sent by the clients through "sendMessage", and the related network throughput (like getCumulMessageBytes()).
StreamMBean name:
"com.lightstreamer:type=Stream"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Double`	`getAllocatedBandwidthKbps()`
`java.lang.Double`	`getAvgSessionBandwidthKbps()`
`java.lang.Long`	`getCumulFilteredEvents()`
`java.lang.Long`	`getCumulInboundEvents()`
`java.lang.Long`	`getCumulItemUpdates()`
`java.lang.Long`	`getCumulLostEvents()`
`java.lang.Long`	`getCumulMessageBytes()`
`java.lang.Long`	`getCumulMessages()`
`java.lang.Long`	`getCumulOutboundBytes()`
`java.lang.Long`	`getCumulPreprocOutboundEvents()`
`java.lang.Double`	`getCurrentBandwidthKbps()`
`java.lang.Double`	`getCurrentMessageThroughputKbps()`
`java.lang.Double`	`getInboundEventFrequency()`
`java.lang.Double`	`getItemUpdateFrequency()`
`java.lang.Double`	`getMaxBandwidthKbps()`
`java.lang.Double`	`getMaxInboundEventFrequency()`
`java.lang.Double`	`getMaxItemUpdateFrequency()`
`java.lang.Double`	`getMaxMessageFrequency()`
`java.lang.Double`	`getMaxMessageThroughputKbps()`
`java.lang.Double`	`getMaxOutboundPreprocEventFrequency()`
`java.lang.Double`	`getMessageFrequency()`
`java.lang.Integer`	`getNewFilteredEvents()`
`java.lang.Integer`	`getNewLostEvents()`
`java.lang.Double`	`getOutboundPreprocEventFrequency()`

- Method Detail
  - getCumulOutboundBytes
```
java.lang.Long getCumulOutboundBytes()
```
    Returns:
    
    The total (cumulative) number of bytes sent in the life of the Server (for Streaming and Polling Connections only). The count includes all HTTP contents sent.
    
    See Also:
    
    getCumulItemUpdates()
  - getCumulItemUpdates
```
java.lang.Long getCumulItemUpdates()
```
    Returns:
    
    The total (cumulative) number of outbound Item Updates sent in the life of the Server. The count includes all Updates sent to the Clients through Streaming and Polling Connections; Updates sent through the Push Notification service are not included.
  - getItemUpdateFrequency
```
java.lang.Double getItemUpdateFrequency()
```
    Returns:
    
    The frequency of outbound Item Updates sent in the last sampling period. It is expressed as updates per second; the value has a three decimal precision.
    
    See Also:
    
    getCumulItemUpdates()
  - getMaxItemUpdateFrequency
```
java.lang.Double getMaxItemUpdateFrequency()
```
    Returns:
    
    The maximum frequency of outbound Item Updates reached in the life of the Server. It is expressed as updates per second; the value has a three decimal precision.
    
    See Also:
    
    getCumulItemUpdates()
  - getCumulInboundEvents
```
java.lang.Long getCumulInboundEvents()
```
    Returns:
    
    The total (cumulative) number of inbound events flowing from all Data Adapters, within any Adapter Set, into LS Kernel.
    
    See Also:
    
    ResourceMBean.getTotalSubscribedItems()
  - getInboundEventFrequency
```
java.lang.Double getInboundEventFrequency()
```
    Returns:
    
    The frequency of inbound events flowing from all Data Adapters, within any Adapter Set, into LS Kernel in the last sampling period. It is expressed as events per second; the value has a three decimal precision.
    
    See Also:
    
    ResourceMBean.getTotalSubscribedItems()
  - getMaxInboundEventFrequency
```
java.lang.Double getMaxInboundEventFrequency()
```
    Returns:
    
    The maximum frequency of inbound events, flowing from all Data Adapters, within any Adapter Set, into LS Kernel, that has been reached in the life of the Server. It is expressed as events per second; the value has a three decimal precision.
    
    See Also:
    
    ResourceMBean.getTotalSubscribedItems()
  - getCumulPreprocOutboundEvents
```
java.lang.Long getCumulPreprocOutboundEvents()
```
    Returns:
    
    The total (cumulative) number of outbound events flowing from the Preprocessor of LS Kernel.
  - getOutboundPreprocEventFrequency
```
java.lang.Double getOutboundPreprocEventFrequency()
```
    Returns:
    
    The frequency of outbound events flowing from the Preprocessor of LS Kernel in the last sampling period. It is expressed as events per second; the value has a three decimal precision.
  - getMaxOutboundPreprocEventFrequency
```
java.lang.Double getMaxOutboundPreprocEventFrequency()
```
    Returns:
    
    The maximum frequency of outbound events flowing from the Preprocessor of LS Kernel reached in the life of the Server. It is expressed as events per second; the value has a three decimal precision.
  - getCurrentBandwidthKbps
```
java.lang.Double getCurrentBandwidthKbps()
```
    Returns:
    
    The current global outbound bandwidth used by the Server (for Streaming and Polling Connections only) in the last sampling period. The count includes network overheads. It is expressed as Kilobits per second; the value has a three decimal precision.
  - getMaxBandwidthKbps
```
java.lang.Double getMaxBandwidthKbps()
```
    Returns:
    
    The maximum global outbound bandwidth used by the Server in its life (for Streaming and Polling Connections only). The count includes network overheads. It is expressed as Kilobits per second; the value has a three decimal precision.
  - getAvgSessionBandwidthKbps
```
java.lang.Double getAvgSessionBandwidthKbps()
```
    Returns:
    
    The average outbound bandwidth used by the Server for each currently active Streaming or Polling Connection (in the last sampling period). The count includes network overheads. It is expressed as Kilobits per second; the value has a three decimal precision.
  - getAllocatedBandwidthKbps
```
java.lang.Double getAllocatedBandwidthKbps()
```
    Returns:
    
    The current outbound allocated bandwidth, calculated as the sum of the maximum outbound bandwidth limits currently enforced by the Server for each active Streaming or Polling Connection. Note that an enforced limit can be smaller than the limit granted to a client, if the client has asked for a custom limit. It is expressed as Kilobits per second; the value has a three decimal precision; a 0 value means that no limit is set. Note that this aggregated value is meaningful only when bandwidth limits are enforced on all Sessions; if even a single Session has no limit currently enforced, the aggregated value is 0.
    
    Edition Note:
    
    Bandwidth control is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please check out the com.lightstreamer.Edition bean.
  - getCumulMessageBytes
```
java.lang.Long getCumulMessageBytes()
```
    Returns:
    
    The total (cumulative) number of bytes submitted to the Metadata Adapter in the life of the Server and related to Client Messages associated to sendMessage requests. The count includes the byte length of the String objects carrying the messages, according with their internal UTF-16 encoding.
  - getCumulMessages
```
java.lang.Long getCumulMessages()
```
    Returns:
    
    The total (cumulative) number of Client Messages submitted to the Metadata Adapter in the life of the Server.
  - getMessageFrequency
```
java.lang.Double getMessageFrequency()
```
    Returns:
    
    The frequency of Client Messages submitted to the Metadata Adapter in the last sampling period. It is expressed as messages per second; the value has a three decimal precision.
  - getMaxMessageFrequency
```
java.lang.Double getMaxMessageFrequency()
```
    Returns:
    
    The maximum frequency of Client Messages submitted to the Metadata Adapter reached in the life of the Server. It is expressed as messages per second; the value has a three decimal precision.
  - getCurrentMessageThroughputKbps
```
java.lang.Double getCurrentMessageThroughputKbps()
```
    Returns:
    
    The current global throughput (measured in the last sampling period) related to the submission to the Metadata Adapter of Client Messages associated to sendMessage requests. The count includes the byte length of the String objects carrying the messages, according with their internal UTF-16 encoding. It is expressed as Kilobits per second; the value has a three decimal precision.
  - getMaxMessageThroughputKbps
```
java.lang.Double getMaxMessageThroughputKbps()
```
    Returns:
    
    The maximum global throughput (occurred in the life of the Server) related to the submission to the Metadata Adapter of Client Messages associated to sendMessage requests. The count includes the byte length of the String objects carrying the messages, according with their internal UTF-16 encoding. It is expressed as Kilobits per second; the value has a three decimal precision.
  - getNewLostEvents
```
java.lang.Integer getNewLostEvents()
```
    Returns:
    
    The number of lost events on all Sessions (as specified for SessionMBean.getNewLostEvents()) in the last sampling period.
  - getCumulLostEvents
```
java.lang.Long getCumulLostEvents()
```
    Returns:
    
    The total (cumulative) number of lost events on all Sessions (as specified for SessionMBean.getNewLostEvents()) in the life of the Server.
  - getNewFilteredEvents
```
java.lang.Integer getNewFilteredEvents()
```
    Returns:
    
    The number of filtered events on all Sessions (as specified for SessionMBean.getNewFilteredEvents()) in the last sampling period.
  - getCumulFilteredEvents
```
java.lang.Long getCumulFilteredEvents()
```
    Returns:
    
    The total (cumulative) number of filtered events on all Sessions (as specified for SessionMBean.getNewFilteredEvents()) in the life of the Server.

Interface StreamMBean

Method Summary

Method Detail

getCumulOutboundBytes

getCumulItemUpdates

getItemUpdateFrequency

getMaxItemUpdateFrequency

getCumulInboundEvents

getInboundEventFrequency

getMaxInboundEventFrequency

getCumulPreprocOutboundEvents

getOutboundPreprocEventFrequency

getMaxOutboundPreprocEventFrequency

getCurrentBandwidthKbps

getMaxBandwidthKbps

getAvgSessionBandwidthKbps

getAllocatedBandwidthKbps

getCumulMessageBytes

getCumulMessages

getMessageFrequency

getMaxMessageFrequency

getCurrentMessageThroughputKbps

getMaxMessageThroughputKbps

getNewLostEvents

getCumulLostEvents

getNewFilteredEvents

getCumulFilteredEvents