wirebox.system.logging.appenders
Class SocketAppender

WEB-INF.cftags.component
        wirebox.system.logging.AbstractAppender
            wirebox.system.logging.appenders.SocketAppender

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 wirebox.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 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 wirebox.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`

Constructor Detail

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

public void closeConnection()

Closes the socket connection

public any getSocket()

Get the socket object

public any getSocketWriter()

Get the socket writer object

public void logMessage(any logEvent)

public void onRegistration()

public void onUnRegistration()

private void openConnection()

Opens a socket connection

Overview

Package

Class

ColdBox Platform - WireBox Version 1.1.1

FRAMES