ColdBox Platform Version 3.7.0

coldbox.system.logging.appenders
Class SocketAppender

WEB-INF.cftags.component
        extended by coldbox.system.logging.AbstractAppender
            extended by coldbox.system.logging.appenders.SocketAppender

public class SocketAppender
extends AbstractAppender

A NIO socket appender


Constructor Summary
init(any name, [any properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
          Constructor
 
Method Summary
 void closeConnection()
          Closes the socket connection
 any getSocket()
          Get the socket object
 any getSocketWriter()
          Get the socket writer object
 void logMessage(any logEvent)
          Write an entry into the appender
 void onRegistration()
          When registration occurs
 void onUnRegistration()
          When Unregistration occurs
private void openConnection()
          Opens a socket connection
 
Methods inherited from class coldbox.system.logging.AbstractAppender
$abort, $dump, $log, $rethrowit, $throw, canLog, getColdbox, getCustomLayout, getHash, getName, getProperties, getProperty, getUtil, getlevelMax, getlevelMin, hasCustomLayout, isInitialized, propertyExists, setColdbox, setInitialized, setLevelMax, setLevelMin, setProperties, setProperty, severityToString
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any name, [any properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
Constructor

Parameters:
name - The unique name for this appender.
properties - A map of configuration properties for the appender
layout - The layout class to use in this appender for custom message rendering.
levelMin - The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARN
levelMax - The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARN
Method Detail

closeConnection

public void closeConnection()
Closes the socket connection


getSocket

public any getSocket()
Get the socket object


getSocketWriter

public any getSocketWriter()
Get the socket writer object


logMessage

public void logMessage(any logEvent)
Write an entry into the appender.

Overrides:
logMessage in class AbstractAppender
Parameters:
logEvent - The logging event

onRegistration

public void onRegistration()
When registration occurs

Overrides:
onRegistration in class AbstractAppender

onUnRegistration

public void onUnRegistration()
When Unregistration occurs

Overrides:
onUnRegistration in class AbstractAppender

openConnection

private void openConnection()
Opens a socket connection


ColdBox Platform Version 3.7.0