MediaWiki master
IBufferingStatsdDataFactory Interface Reference

MediaWiki adaptation of StatsdDataFactory that provides buffering functionality. More...

Inherits StatsdDataFactoryInterface.

Inherited by BufferingStatsdDataFactory, and NullStatsdDataFactory.

Collaboration diagram for IBufferingStatsdDataFactory:

Public Member Functions

 clearData ()
 Clear all buffered data from the factory.
 
 getData ()
 Return the buffered data from the factory.
 
 getDataCount ()
 Return the number of buffered statsd data entries.
 
 hasData ()
 Check whether this data factory has any buffered data.
 
 setEnabled ( $enabled)
 Set collection enable status.
 

Detailed Description

MediaWiki adaptation of StatsdDataFactory that provides buffering functionality.

Stability: stable
to implement
Since
1.30
See also
BufferingStatsdDataFactory

Definition at line 13 of file IBufferingStatsdDataFactory.php.

Member Function Documentation

◆ clearData()

IBufferingStatsdDataFactory::clearData ( )

Clear all buffered data from the factory.

Since
1.31

Implemented in BufferingStatsdDataFactory, and NullStatsdDataFactory.

Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStatsdData().

◆ getData()

IBufferingStatsdDataFactory::getData ( )

Return the buffered data from the factory.

Returns
StatsdData[]

Implemented in BufferingStatsdDataFactory, and NullStatsdDataFactory.

Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStatsdData().

◆ getDataCount()

IBufferingStatsdDataFactory::getDataCount ( )

Return the number of buffered statsd data entries.

Returns
int
Since
1.31

Implemented in BufferingStatsdDataFactory, and NullStatsdDataFactory.

Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStatsdData().

◆ hasData()

IBufferingStatsdDataFactory::hasData ( )

Check whether this data factory has any buffered data.

Returns
bool

Implemented in BufferingStatsdDataFactory, and NullStatsdDataFactory.

Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStatsdData().

◆ setEnabled()

IBufferingStatsdDataFactory::setEnabled (   $enabled)

Set collection enable status.

Parameters
bool$enabledWill collection be enabled?
Returns
void

Implemented in BufferingStatsdDataFactory, and NullStatsdDataFactory.


The documentation for this interface was generated from the following file: