Docs For Class LoggerAppenderSocket

Description

Serialize events and send them to a network socket.

Serialize events and send them to a network socket. Parameters are $remoteHost, $port, $timeout, $locationInfo, $useXml and $log4jNamespace.

version: $Revision: 1.16 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/appenders/LoggerAppenderSocket.php (line 44)

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderSocket

Variable Summary

boolean $locationInfo

boolean $log4jNamespace

integer $port

string $remoteHost

integer $timeout

boolean $useXml

Method Summary

LoggerAppenderSocket LoggerAppenderSocket (string $name)

void activateOptions ()

void append (LoggerLoggingEvent $event)

void close ()

string getHostname ()

boolean getLocationInfo ()

boolean getLog4jNamespace ()

integer getPort ()

void getRemoteHost ()

integer getTimeout ()

void getUseXml ()

void reset ()

void setHostname (string $hostname)

void setLocationInfo (mixed $flag)

void setLog4jNamespace (mixed $flag)

void setPort (integer $port)

void setRemoteHost (string $hostname)

void setTimeout (integer $timeout)

void setUseXml (mixed $flag)

Variables

boolean $locationInfo = false (line 67)

var: get event's location info.

boolean $log4jNamespace = false (line 83)

var: forward this option to LoggerXmlLayout. Ignored if $useXml is false.

integer $port = LOG4PHP_LOGGER_APPENDER_SOCKET_DEFAULT_PORT (line 62)

var: the network port.

string $remoteHost = '' (line 57)

Target host.

Target host. On how to define remote hostaname see http://www.php.net/fsockopen

integer $timeout = LOG4PHP_LOGGER_APPENDER_SOCKET_DEFAULT_TIMEOUT (line 72)

var: connection timeout

boolean $useXml = false (line 77)

var: output events via LoggerXmlLayout

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold

Methods

Constructor LoggerAppenderSocket (line 102)

Constructor

LoggerAppenderSocket LoggerAppenderSocket (string $name)

string $name: appender name

activateOptions (line 110)

Create a socket connection using defined parameters

void activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions(): Derived appenders should override this method if option structure requires it.

append (line 268)

void append (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

LoggerAppenderSkeleton::append(): Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.

close (line 138)

void close ()

Redefinition of:

LoggerAppenderSkeleton::close()

getHostname (line 150)

string getHostname ()

getLocationInfo (line 158)

boolean getLocationInfo ()

getLog4jNamespace (line 166)

boolean getLog4jNamespace ()

getPort (line 174)

integer getPort ()

getRemoteHost (line 179)

void getRemoteHost ()

getTimeout (line 187)

integer getTimeout ()

getUseXml (line 195)

void getUseXml ()

reset (line 200)

void reset ()

setHostname (line 210)

deprecated: Please, use setRemoteHost

void setHostname (string $hostname)

string $hostname

setLocationInfo (line 218)

void setLocationInfo (mixed $flag)

mixed $flag

setLog4jNamespace (line 226)

void setLog4jNamespace (mixed $flag)

mixed $flag

setPort (line 234)

void setPort (integer $port)

integer $port

setRemoteHost (line 244)

void setRemoteHost (string $hostname)

string $hostname

setTimeout (line 252)

void setTimeout (integer $timeout)

integer $timeout

setUseXml (line 260)

void setUseXml (mixed $flag)

mixed $flag

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::LoggerAppenderSkeleton()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
LoggerAppenderSkeleton::close()
LoggerAppenderSkeleton::doAppend()
LoggerAppenderSkeleton::finalize()
LoggerAppenderSkeleton::getErrorHandler()
LoggerAppenderSkeleton::getFilter()
LoggerAppenderSkeleton::getFirstFilter()
LoggerAppenderSkeleton::getLayout()
LoggerAppenderSkeleton::getName()
LoggerAppenderSkeleton::getThreshold()
LoggerAppenderSkeleton::isAsSevereAsThreshold()
LoggerAppenderSkeleton::requiresLayout()
LoggerAppenderSkeleton::setErrorHandler()
LoggerAppenderSkeleton::setLayout()
LoggerAppenderSkeleton::setName()
LoggerAppenderSkeleton::setThreshold()
LoggerAppenderSkeleton::__sleep()
LoggerAppenderSkeleton::__wakeup()

Inherited From LoggerAppender

LoggerAppender::addFilter()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::factory()
LoggerAppender::getErrorHandler()
LoggerAppender::getFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::requiresLayout()
LoggerAppender::setErrorHandler()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::singleton()