Docs For Class LoggerAppenderSocket

Description

Log events to a network socket.

Log events to a network socket. Parameters are $hostname, $port, $timeout.

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

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

LoggerAppenderSkeleton
   |
   --LoggerAppenderSocket

Variable Summary

string $hostname

integer $port

mixed $sp

integer $timeout

Method Summary

LoggerAppenderSocket LoggerAppenderSocket (string $name)

boolean activateOptions ()

void append (mixed $event)

void close ()

void closeFile ()

void getAppend ()

void getHostname ()

void getPort ()

void getTimeout ()

void reset ()

void setAppend (mixed $flag)

void setHostname (mixed $hostname)

void setPort (mixed $port)

void setTimeout (mixed $timeout)

Variables

string $hostname = '' (line 42)

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

integer $port = null (line 47)

var: network port

mixed $sp = 0 (line 37)

socket connection resource

integer $timeout = 30 (line 52)

var: connection timeout

Inherited Variables

Inherited from LoggerAppenderSkeleton

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

Methods

Constructor LoggerAppenderSocket (line 59)

Constructor

LoggerAppenderSocket LoggerAppenderSocket (string $name)

string $name: appender name

activateOptions (line 68)

create a socket connection using defined parameters

boolean activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions()

append (line 164)

void append (mixed $event)

Redefinition of:

LoggerAppenderSkeleton::append()

Subclasses of


1     LoggerAppenderSkeleton

should implement this method to perform actual logging.

close (line 86)

void close ()

Redefinition of:

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

closeFile (line 94)

Closes the previously opened file.

void closeFile ()

getAppend (line 104)

Returns the value of the Append option.

void getAppend ()

getHostname (line 109)

void getHostname ()

getPort (line 114)

void getPort ()

getTimeout (line 119)

void getTimeout ()

reset (line 128)

Close any previously opened file and call the parent's reset.

void reset ()

setAppend (line 138)

The Append option takes a boolean value.

void setAppend (mixed $flag)

setHostname (line 146)

The BufferedIO option takes a boolean value.

void setHostname (mixed $hostname)

setPort (line 154)

Set the size of the IO buffer.

void setPort (mixed $port)

setTimeout (line 159)

void setTimeout (mixed $timeout)

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