Monolog\Handler\SocketHandler Class Reference

Stores to any socket - uses fsockopen() or pfsockopen(). More...

Inheritance diagram for Monolog\Handler\SocketHandler:

Collaboration diagram for Monolog\Handler\SocketHandler:

Public Member Functions
	__construct ($connectionString, $level=Logger::DEBUG, $bubble=true)
	close ()
	We will not close a PersistentSocket instance so it can be reused in other requests. More...
	closeSocket ()
	Close socket, if open. More...
	setPersistent ($persistent)
	Set socket connection to nbe persistent. More...
	setConnectionTimeout ($seconds)
	Set connection timeout. More...
	setTimeout ($seconds)
	Set write timeout. More...
	setWritingTimeout ($seconds)
	Set writing timeout. More...
	setChunkSize ($bytes)
	Set chunk size. More...
	getConnectionString ()
	Get current connection string. More...
	isPersistent ()
	Get persistent setting. More...
	getConnectionTimeout ()
	Get current connection timeout setting. More...
	getTimeout ()
	Get current in-transfer timeout. More...
	getWritingTimeout ()
	Get current local writing timeout. More...
	getChunkSize ()
	Get current chunk size. More...
	isConnected ()
	Check to see if the socket is currently available. More...
Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	handle (array $record)
	{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record. Parameters array $record The record to handle Returns bool true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling. } More...
Public Member Functions inherited from Monolog\Handler\AbstractHandler
	__construct ($level=Logger::DEBUG, $bubble=true)
	isHandling (array $record)
	{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record. Parameters array $record Partial log record containing only a level key Returns bool } More...
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	close ()
	Closes the handler. More...
	pushProcessor ($callback)
	{Adds a processor in the stack. Parameters callable $callback Returns self } More...
	popProcessor ()
	{Removes the processor on top of the stack and returns it. Returns callable } More...
	setFormatter (FormatterInterface $formatter)
	{Sets the formatter. Parameters FormatterInterface $formatter Returns self } More...
	getFormatter ()
	{Gets the formatter. Returns FormatterInterface } More...
	setLevel ($level)
	Sets minimum logging level at which this handler will be triggered. More...
	getLevel ()
	Gets minimum logging level at which this handler will be triggered. More...
	setBubble ($bubble)
	Sets the bubbling behavior. More...
	getBubble ()
	Gets the bubbling behavior. More...
	__destruct ()
	reset ()

Protected Member Functions
	write (array $record)
	Connect (if necessary) and write to the socket. More...
	pfsockopen ()
	Wrapper to allow mocking. More...
	fsockopen ()
	Wrapper to allow mocking. More...
	streamSetTimeout ()
	Wrapper to allow mocking. More...
	streamSetChunkSize ()
	Wrapper to allow mocking. More...
	fwrite ($data)
	Wrapper to allow mocking. More...
	streamGetMetadata ()
	Wrapper to allow mocking. More...
	generateDataStream ($record)
	getResource ()
Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...
	processRecord (array $record)
	Processes a record. More...
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Private Member Functions
	validateTimeout ($value)
	connectIfNotConnected ()
	connect ()
	createSocketResource ()
	setSocketTimeout ()
	setStreamChunkSize ()
	writeToSocket ($data)
	writingIsTimedOut ($sent)

Private Attributes
	$connectionString
	$connectionTimeout
	$resource
	$timeout = 0
	$writingTimeout = 10
	$lastSentBytes = null
	$chunkSize = null
	$persistent = false
	$errno
	$errstr
	$lastWritingAt

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Stores to any socket - uses fsockopen() or pfsockopen().

Author

Pablo de Leon Belloc pablo.nosp@m.lb@g.nosp@m.mail..nosp@m.com

See also

http://php.net/manual/en/function.fsockopen.php

Definition at line 22 of file SocketHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\SocketHandler::__construct	(		$connectionString,
			$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

string	$connectionString	Socket connection string
int	$level	The minimum logging level at which this handler will be triggered
bool	$bubble	Whether the messages that are handled can bubble up the stack or not

Definition at line 41 of file SocketHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\SocketHandler\$connectionString, and Monolog\Handler\AbstractHandler\$level.

    {
        parent::__construct($level, $bubble);
        $this->connectionString = $connectionString;
        $this->connectionTimeout = (float) ini_get('default_socket_timeout');
    }

Member Function Documentation

close()

Monolog\Handler\SocketHandler::close

(

)

We will not close a PersistentSocket instance so it can be reused in other requests.

Definition at line 66 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\closeSocket(), and Monolog\Handler\SocketHandler\isPersistent().

    {
        if (!$this->isPersistent()) {
            $this->closeSocket();
        }
    }

Here is the call graph for this function:

closeSocket()

Monolog\Handler\SocketHandler::closeSocket

(

)

Close socket, if open.

Definition at line 76 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\close(), Monolog\Handler\SlackHandler\finalizeWrite(), Monolog\Handler\HipChatHandler\finalizeWrite(), Monolog\Handler\FleepHookHandler\write(), Monolog\Handler\FlowdockHandler\write(), Monolog\Handler\PushoverHandler\write(), and Monolog\Handler\SocketHandler\writingIsTimedOut().

    {
        if (is_resource($this->resource)) {
            fclose($this->resource);
            $this->resource = null;
        }
    }

Here is the caller graph for this function:

connect()

Monolog\Handler\SocketHandler::connect ( )

private

Definition at line 298 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\createSocketResource(), Monolog\Handler\SocketHandler\setSocketTimeout(), and Monolog\Handler\SocketHandler\setStreamChunkSize().

Referenced by Monolog\Handler\SocketHandler\connectIfNotConnected().

    {
        $this->createSocketResource();
        $this->setSocketTimeout();
        $this->setStreamChunkSize();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

connectIfNotConnected()

Monolog\Handler\SocketHandler::connectIfNotConnected ( )

private

Definition at line 277 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\connect(), and Monolog\Handler\SocketHandler\isConnected().

Referenced by Monolog\Handler\SocketHandler\write().

    {
        if ($this->isConnected()) {
            return;
        }
        $this->connect();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createSocketResource()

Monolog\Handler\SocketHandler::createSocketResource ( )

private

Definition at line 305 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$resource, Monolog\Handler\SocketHandler\fsockopen(), Monolog\Handler\SocketHandler\isPersistent(), and Monolog\Handler\SocketHandler\pfsockopen().

Referenced by Monolog\Handler\SocketHandler\connect().

    {
        if ($this->isPersistent()) {
            $resource = $this->pfsockopen();
        } else {
            $resource = $this->fsockopen();
        }
        if (!$resource) {
            throw new \UnexpectedValueException("Failed connecting to $this->connectionString ($this->errno: $this->errstr)");
        }
        $this->resource = $resource;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fsockopen()

Monolog\Handler\SocketHandler::fsockopen ( )

protected

Wrapper to allow mocking.

Definition at line 225 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\createSocketResource().

    {
        return @fsockopen($this->connectionString, -1, $this->errno, $this->errstr, $this->connectionTimeout);
    }

Here is the caller graph for this function:

fwrite()

Monolog\Handler\SocketHandler::fwrite (   $data )

protected

Wrapper to allow mocking.

Definition at line 256 of file SocketHandler.php.

References $data.

Referenced by Monolog\Handler\SocketHandler\writeToSocket().

    {
        return @fwrite($this->resource, $data);
    }

Here is the caller graph for this function:

generateDataStream()

Monolog\Handler\SocketHandler::generateDataStream (   $record )

protected

Definition at line 285 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\write().

    {
        return (string) $record['formatted'];
    }

Here is the caller graph for this function:

getChunkSize()

Monolog\Handler\SocketHandler::getChunkSize

(

)

Get current chunk size.

Returns

float

Definition at line 196 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$chunkSize.

    {
        return $this->chunkSize;
    }

getConnectionString()

Monolog\Handler\SocketHandler::getConnectionString

(

)

Get current connection string.

Returns

string

Definition at line 146 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$connectionString.

    {
        return $this->connectionString;
    }

getConnectionTimeout()

Monolog\Handler\SocketHandler::getConnectionTimeout

(

)

Get current connection timeout setting.

Returns

float

Definition at line 166 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$connectionTimeout.

    {
        return $this->connectionTimeout;
    }

getResource()

Monolog\Handler\SocketHandler::getResource ( )

protected

Returns

resource|null

Definition at line 293 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$resource.

Referenced by Monolog\Handler\SlackHandler\finalizeWrite(), and Monolog\Handler\HipChatHandler\finalizeWrite().

    {
        return $this->resource;
    }

Here is the caller graph for this function:

getTimeout()

Monolog\Handler\SocketHandler::getTimeout

(

)

Get current in-transfer timeout.

Returns

float

Definition at line 176 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$timeout.

    {
        return $this->timeout;
    }

getWritingTimeout()

Monolog\Handler\SocketHandler::getWritingTimeout

(

)

Get current local writing timeout.

Returns

float

Definition at line 186 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$writingTimeout.

    {
        return $this->writingTimeout;
    }

isConnected()

Monolog\Handler\SocketHandler::isConnected

(

)

Check to see if the socket is currently available.

UDP might appear to be connected but might fail when writing. See http://php.net/fsockopen for details.

Returns

bool

Definition at line 208 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\connectIfNotConnected(), and Monolog\Handler\SocketHandler\writeToSocket().

    {
        return is_resource($this->resource)
            && !feof($this->resource);  // on TCP - other party can close connection.
    }

Here is the caller graph for this function:

isPersistent()

Monolog\Handler\SocketHandler::isPersistent

(

)

Get persistent setting.

Returns

bool

Definition at line 156 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$persistent.

Referenced by Monolog\Handler\SocketHandler\close(), and Monolog\Handler\SocketHandler\createSocketResource().

    {
        return $this->persistent;
    }

Here is the caller graph for this function:

pfsockopen()

Monolog\Handler\SocketHandler::pfsockopen ( )

protected

Wrapper to allow mocking.

Definition at line 217 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\createSocketResource().

    {
        return @pfsockopen($this->connectionString, -1, $this->errno, $this->errstr, $this->connectionTimeout);
    }

Here is the caller graph for this function:

setChunkSize()

Monolog\Handler\SocketHandler::setChunkSize

(

$bytes

)

Set chunk size.

Only has effect during connection in the writing cycle.

Parameters

float

$bytes

Definition at line 136 of file SocketHandler.php.

    {
        $this->chunkSize = $bytes;
    }

setConnectionTimeout()

Monolog\Handler\SocketHandler::setConnectionTimeout

(

$seconds

)

Set connection timeout.

Only has effect before we connect.

Parameters

float

$seconds

See also

http://php.net/manual/en/function.fsockopen.php

Definition at line 101 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\validateTimeout().

    {
        $this->validateTimeout($seconds);
        $this->connectionTimeout = (float) $seconds;
    }

Here is the call graph for this function:

setPersistent()

Monolog\Handler\SocketHandler::setPersistent

(

$persistent

)

Set socket connection to nbe persistent.

It only has effect before the connection is initiated.

Parameters

bool

$persistent

Definition at line 89 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$persistent.

    {
        $this->persistent = (bool) $persistent;
    }

setSocketTimeout()

Monolog\Handler\SocketHandler::setSocketTimeout ( )

private

Definition at line 318 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\streamSetTimeout().

Referenced by Monolog\Handler\SocketHandler\connect().

    {
        if (!$this->streamSetTimeout()) {
            throw new \UnexpectedValueException("Failed setting timeout with stream_set_timeout()");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setStreamChunkSize()

Monolog\Handler\SocketHandler::setStreamChunkSize ( )

private

Definition at line 325 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\streamSetChunkSize().

Referenced by Monolog\Handler\SocketHandler\connect().

    {
        if ($this->chunkSize && !$this->streamSetChunkSize()) {
            throw new \UnexpectedValueException("Failed setting chunk size with stream_set_chunk_size()");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTimeout()

Monolog\Handler\SocketHandler::setTimeout

(

$seconds

)

Set write timeout.

Only has effect before we connect.

Parameters

float

$seconds

See also

http://php.net/manual/en/function.stream-set-timeout.php

Definition at line 114 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\validateTimeout().

    {
        $this->validateTimeout($seconds);
        $this->timeout = (float) $seconds;
    }

Here is the call graph for this function:

setWritingTimeout()

Monolog\Handler\SocketHandler::setWritingTimeout

(

$seconds

)

Set writing timeout.

Only has effect during connection in the writing cycle.

Parameters

float

$seconds

0 for no timeout

Definition at line 125 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\validateTimeout().

    {
        $this->validateTimeout($seconds);
        $this->writingTimeout = (float) $seconds;
    }

Here is the call graph for this function:

streamGetMetadata()

Monolog\Handler\SocketHandler::streamGetMetadata ( )

protected

Wrapper to allow mocking.

Definition at line 264 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\writeToSocket().

    {
        return stream_get_meta_data($this->resource);
    }

Here is the caller graph for this function:

streamSetChunkSize()

Monolog\Handler\SocketHandler::streamSetChunkSize ( )

protected

Wrapper to allow mocking.

See also

http://php.net/manual/en/function.stream-set-chunk-size.php

Definition at line 248 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\setStreamChunkSize().

    {
        return stream_set_chunk_size($this->resource, $this->chunkSize);
    }

Here is the caller graph for this function:

streamSetTimeout()

Monolog\Handler\SocketHandler::streamSetTimeout ( )

protected

Wrapper to allow mocking.

See also

http://php.net/manual/en/function.stream-set-timeout.php

Definition at line 235 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\setSocketTimeout().

    {
        $seconds = floor($this->timeout);
        $microseconds = round(($this->timeout - $seconds) * 1e6);

        return stream_set_timeout($this->resource, $seconds, $microseconds);
    }

Here is the caller graph for this function:

validateTimeout()

Monolog\Handler\SocketHandler::validateTimeout (   $value )

private

Definition at line 269 of file SocketHandler.php.

References $ok.

Referenced by Monolog\Handler\SocketHandler\setConnectionTimeout(), Monolog\Handler\SocketHandler\setTimeout(), and Monolog\Handler\SocketHandler\setWritingTimeout().

    {
        $ok = filter_var($value, FILTER_VALIDATE_FLOAT);
        if ($ok === false || $value < 0) {
            throw new \InvalidArgumentException("Timeout must be 0 or a positive float (got $value)");
        }
    }

Here is the caller graph for this function:

write()

Monolog\Handler\SocketHandler::write ( array  $record )

protected

Connect (if necessary) and write to the socket.

Parameters

array

$record

Exceptions

Definition at line 56 of file SocketHandler.php.

References $data, Monolog\Handler\SocketHandler\connectIfNotConnected(), Monolog\Handler\SocketHandler\generateDataStream(), and Monolog\Handler\SocketHandler\writeToSocket().

    {
        $this->connectIfNotConnected();
        $data = $this->generateDataStream($record);
        $this->writeToSocket($data);
    }

Here is the call graph for this function:

writeToSocket()

Monolog\Handler\SocketHandler::writeToSocket (   $data )

private

Definition at line 332 of file SocketHandler.php.

References $data, Monolog\Handler\SocketHandler\fwrite(), Monolog\Handler\SocketHandler\isConnected(), Monolog\Handler\SocketHandler\streamGetMetadata(), and Monolog\Handler\SocketHandler\writingIsTimedOut().

Referenced by Monolog\Handler\SocketHandler\write().

    {
        $length = strlen($data);
        $sent = 0;
        $this->lastSentBytes = $sent;
        while ($this->isConnected() && $sent < $length) {
            if (0 == $sent) {
                $chunk = $this->fwrite($data);
            } else {
                $chunk = $this->fwrite(substr($data, $sent));
            }
            if ($chunk === false) {
                throw new \RuntimeException("Could not write to socket");
            }
            $sent += $chunk;
            $socketInfo = $this->streamGetMetadata();
            if ($socketInfo['timed_out']) {
                throw new \RuntimeException("Write timed-out");
            }

            if ($this->writingIsTimedOut($sent)) {
                throw new \RuntimeException("Write timed-out, no data sent for `{$this->writingTimeout}` seconds, probably we got disconnected (sent $sent of $length)");
            }
        }
        if (!$this->isConnected() && $sent < $length) {
            throw new \RuntimeException("End-of-file reached, probably we got disconnected (sent $sent of $length)");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writingIsTimedOut()

Monolog\Handler\SocketHandler::writingIsTimedOut (   $sent )

private

Definition at line 361 of file SocketHandler.php.

References Monolog\Handler\SocketHandler\$writingTimeout, and Monolog\Handler\SocketHandler\closeSocket().

Referenced by Monolog\Handler\SocketHandler\writeToSocket().

    {
        $writingTimeout = (int) floor($this->writingTimeout);
        if (0 === $writingTimeout) {
            return false;
        }

        if ($sent !== $this->lastSentBytes) {
            $this->lastWritingAt = time();
            $this->lastSentBytes = $sent;

            return false;
        } else {
            usleep(100);
        }

        if ((time() - $this->lastWritingAt) >= $writingTimeout) {
            $this->closeSocket();

            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$chunkSize

Monolog\Handler\SocketHandler::$chunkSize = null

private

Definition at line 30 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\getChunkSize().

$connectionString

Monolog\Handler\SocketHandler::$connectionString

private

Definition at line 24 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\__construct(), Monolog\Handler\FleepHookHandler\__construct(), Monolog\Handler\PushoverHandler\__construct(), Monolog\Handler\HipChatHandler\__construct(), and Monolog\Handler\SocketHandler\getConnectionString().

$connectionTimeout

Monolog\Handler\SocketHandler::$connectionTimeout

private

Definition at line 25 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\getConnectionTimeout().

$errno

Monolog\Handler\SocketHandler::$errno

private

Definition at line 32 of file SocketHandler.php.

$errstr

Monolog\Handler\SocketHandler::$errstr

private

Definition at line 33 of file SocketHandler.php.

$lastSentBytes

Monolog\Handler\SocketHandler::$lastSentBytes = null

private

Definition at line 29 of file SocketHandler.php.

$lastWritingAt

Monolog\Handler\SocketHandler::$lastWritingAt

private

Definition at line 34 of file SocketHandler.php.

$persistent

Monolog\Handler\SocketHandler::$persistent = false

private

Definition at line 31 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\isPersistent(), and Monolog\Handler\SocketHandler\setPersistent().

$resource

Monolog\Handler\SocketHandler::$resource

private

Definition at line 26 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\createSocketResource(), and Monolog\Handler\SocketHandler\getResource().

$timeout

Monolog\Handler\SocketHandler::$timeout = 0

private

Definition at line 27 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\getTimeout().

$writingTimeout

Monolog\Handler\SocketHandler::$writingTimeout = 10

private

Definition at line 28 of file SocketHandler.php.

Referenced by Monolog\Handler\SocketHandler\getWritingTimeout(), and Monolog\Handler\SocketHandler\writingIsTimedOut().

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Handler/SocketHandler.php