MediaWiki adaptation of StatsdDataFactory that provides buffering functionality. More...
Inherits StatsdDataFactoryInterface.
Inherited by Wikimedia\Stats\BufferingStatsdDataFactory, and Wikimedia\Stats\NullStatsdDataFactory.
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 15 of file IBufferingStatsdDataFactory.php.
Member Function Documentation
◆ clearData()
| Wikimedia\Stats\IBufferingStatsdDataFactory::clearData | ( | ) |
Clear all buffered data from the factory.
- Since
- 1.31
Implemented in Wikimedia\Stats\BufferingStatsdDataFactory, and Wikimedia\Stats\NullStatsdDataFactory.
Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStats().
◆ getData()
| Wikimedia\Stats\IBufferingStatsdDataFactory::getData | ( | ) |
Return the buffered data from the factory.
- Returns
- StatsdData[]
Implemented in Wikimedia\Stats\BufferingStatsdDataFactory, and Wikimedia\Stats\NullStatsdDataFactory.
Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStats().
◆ getDataCount()
| Wikimedia\Stats\IBufferingStatsdDataFactory::getDataCount | ( | ) |
Return the number of buffered statsd data entries.
- Returns
- int
- Since
- 1.31
Implemented in Wikimedia\Stats\BufferingStatsdDataFactory, and Wikimedia\Stats\NullStatsdDataFactory.
Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStats().
◆ hasData()
| Wikimedia\Stats\IBufferingStatsdDataFactory::hasData | ( | ) |
Check whether this data factory has any buffered data.
- Returns
- bool
Implemented in Wikimedia\Stats\BufferingStatsdDataFactory, and Wikimedia\Stats\NullStatsdDataFactory.
Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStats().
◆ setEnabled()
| Wikimedia\Stats\IBufferingStatsdDataFactory::setEnabled | ( | $enabled | ) |
Set collection enable status.
- Parameters
-
bool $enabled Will collection be enabled?
- Returns
- void
Implemented in Wikimedia\Stats\BufferingStatsdDataFactory, and Wikimedia\Stats\NullStatsdDataFactory.
The documentation for this interface was generated from the following file:
- includes/libs/Stats/IBufferingStatsdDataFactory.php
