Class LoggerAppenderSocket

(line 26)
LoggerAppender
   |
   --LoggerAppenderSocket

Located in File: Program_Root/appender/LoggerAppenderSocket.php

Log event to a network socket
Class Variable Summary
$hostname
on how to define an hostname see http://php.net/fsockopen
Default Value: -><-
$port
Default Value: ->null<-
$sp
Default Value: ->0<-
$timeout
Default Value: ->30<-
Inherited Class Variable Summary
Inherited From Class LoggerAppender
Variable Default Value Description
LoggerAppender::$closed -> <-
LoggerAppender::$errorHandler -> <-
LoggerAppender::$filters ->array() <-
LoggerAppender::$headFilter ->null <-
LoggerAppender::$layout ->null <-
LoggerAppender::$name -> <-
LoggerAppender::$requiresLayout ->false <-
LoggerAppender::$tailFilter ->null <-
LoggerAppender::$threshold -> <-
Method Summary
void constructor LoggerAppenderSocket ( $name )
Constructor
boolean activateOptions ( )
create a socket connection using defined parameters
void close ( )
void closeFile ( )
Closes the previously opened file.
void doAppend ( $event )
Appends a LoggerEvent
void getAppend ( )
Returns the value of the Append option.
void getHostname ( )
Get the value of the BufferedIO option.
void getPort ( )
Get the size of the IO buffer.
void reset ( )
Close any previously opened file and call the parent's reset.
void setAppend ( $flag )
The Append option takes a boolean value.
void setHostname ( $hostname )
The BufferedIO option takes a boolean value.
void setPort ( $port )
Set the size of the IO buffer.
void setTimeout ( $timeout )
Inherited Method Summary
Inherited From Class LoggerAppender
Function Description
LoggerAppender::LoggerAppender() Constructor
LoggerAppender::addFilter() Add a filter to the end of the filter list.
LoggerAppender::clearFilters() Clear the list of filters by removing all the filters in it.
LoggerAppender::close() Release any resources allocated.
LoggerAppender::doAppend() Log in Appender specific way.
LoggerAppender::factory() Factory
LoggerAppender::getErrorHandler() Returns the ErrorHandler for this appender.
LoggerAppender::getFilter() Returns the head Filter.
LoggerAppender::getLayout() Returns this appender layout.
LoggerAppender::getName() Get the name of this appender.
LoggerAppender::requiresLayout() Configurators call this method to determine if the appender requires a layout.
LoggerAppender::setErrorHandler() Set the ErrorHandler for this appender.
LoggerAppender::setLayout() Set the Layout for this appender.
LoggerAppender::setName() Set the name of this appender.
LoggerAppender::singleton() Singleton
Method Detail

Constructor LoggerAppenderSocket

(line 54)

void LoggerAppenderSocket( string $name)

Constructor
Function Parameters:
- string $name: appender name
Function Info:

[ Top ]

activateOptions

(line 63)

boolean activateOptions( )

create a socket connection using defined parameters
Function Info:

[ Top ]

close

(line 81)

void close( )

Overrides LoggerAppender::close() (Release any resources allocated.)


Function Info:

[ Top ]

closeFile

(line 89)

void closeFile( )

Closes the previously opened file.
Function Info:

[ Top ]

doAppend

(line 164)

void doAppend( object $event)

Overrides LoggerAppender::doAppend() (Log in Appender specific way.)

Appends a LoggerEvent
Function Parameters:
- object $event: the LoggerEvent to append
Function Info:

[ Top ]

getAppend

(line 99)

void getAppend( )

Returns the value of the Append option.
Function Info:

[ Top ]

getHostname

(line 107)

void getHostname( )

Get the value of the BufferedIO option.
Function Info:

[ Top ]

getPort

(line 115)

void getPort( )

Get the size of the IO buffer.
Function Info:

[ Top ]

reset

(line 123)

void reset( )

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

[ Top ]

setAppend

(line 133)

void setAppend( mixed $flag)

The Append option takes a boolean value.
Function Info:

[ Top ]

setHostname

(line 141)

void setHostname( mixed $hostname)

The BufferedIO option takes a boolean value.
Function Info:

[ Top ]

setPort

(line 149)

void setPort( mixed $port)

Set the size of the IO buffer.
Function Info:

[ Top ]

setTimeout

(line 154)

void setTimeout( mixed $timeout)


Function Info:

[ Top ]

Variable Detail

$hostname

(line 37)
Data type: string
on how to define an hostname see http://php.net/fsockopen

[ Top ]

$port

(line 42)
Data type: integer

[ Top ]

$sp

(line 31)
Data type: resource

[ Top ]

$timeout

(line 47)
Data type: integer

[ Top ]

Documention generated on Thu, 20 Feb 2003 15:43:01 +0100 by phpDocumentor 1.2.0rc1