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 $hostname, $port, $timeout.

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

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

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderSocket

Variable Summary

string $hostname

integer $port

mixed $requiresLayout

integer $timeout

boolean $useXml

LoggerXmlLayout $xmlLayout

Method Summary

LoggerAppenderSocket LoggerAppenderSocket (string $name)

boolean activateOptions ()

void append (mixed $event)

void close ()

void closeFile ()

void getHostname ()

void getPort ()

void getTimeout ()

void getUseXml ()

void reset ()

void setHostname (mixed $hostname)

void setPort (mixed $port)

void setTimeout (mixed $timeout)

void setUseXml (mixed $flag)

Variables

string $hostname = '' (line 55)

Target host.

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

integer $port = null (line 60)

var: network port

mixed $requiresLayout = false (line 78)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

integer $timeout = 30 (line 65)

var: connection timeout

boolean $useXml = false (line 70)

var: output events via LoggerXmlLayout

LoggerXmlLayout $xmlLayout = null (line 76)

private:

Inherited Variables

Inherited from LoggerAppenderSkeleton

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

Methods

Constructor LoggerAppenderSocket (line 85)

Constructor

LoggerAppenderSocket LoggerAppenderSocket (string $name)

string $name: appender name

activateOptions (line 94)

Create a socket connection using defined parameters

boolean activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions(): Called after the appender paramters are set with setter methods.

append (line 200)

void append (mixed $event)

Redefinition of:

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

close (line 123)

void close ()

Redefinition of:

LoggerAppenderSkeleton::close(): Release any resources allocated.

closeFile (line 134)

Closes the network connection.

void closeFile ()

getHostname (line 144)

void getHostname ()

getPort (line 152)

void getPort ()

getTimeout (line 160)

void getTimeout ()

getUseXml (line 168)

void getUseXml ()

reset (line 174)

void reset ()

setHostname (line 180)

void setHostname (mixed $hostname)

setPort (line 185)

void setPort (mixed $port)

setTimeout (line 190)

void setTimeout (mixed $timeout)

setUseXml (line 195)

void setUseXml (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()

Inherited From LoggerAppender

LoggerAppender::factory()
LoggerAppender::singleton()