logbox.system.logging.appenders

Class SocketAppender

lucee.Component
    extended by logbox.system.logging.AbstractAppender
      extended by logbox.system.logging.appenders.SocketAppender

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- A socket appender that logs to a socket Properties: - host : the host to connect to - port : the port to connect to - timeout : the timeout in seconds. defaults to 5 seconds - persistConnection : Whether to persist the connection or create a new one every log time. Defaults to true;

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any socket
          The actual socket server.

    • access = public
    • returntype = any
    		 true false
    any socketWriter
          The socket writer class.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any name, [struct properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
          Constructor.
    Method Summary
    any closeConnection()
         Close Connection.
    string getSocket()
    string getSocketWriter()
    any logMessage(LogEvent logEvent)
         Write an entry into the appender.
    any onRegistration()
         When registration occurs.
    any onUnRegistration()
         When Unregistration occurs.
    private any openConnection()
         Open a socket connection.
    any setSocket(any socket)
    any setSocketWriter(any socketWriter)
     
    Methods inherited from class logbox.system.logging.AbstractAppender
    $log, canLog, getColdbox, getCustomLayout, getHash, getInitialized, getLevelMax, getLevelMin, getName, getProperties, getProperty, getUtil, hasCustomLayout, isInitialized, out, propertyExists, setColdbox, setCustomLayout, setInitialized, setLevelMax, setLevelMin, setName, setProperties, setProperty, severityToString
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any name, [struct 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
    Property Detail

    socket

    property any socket

    The actual socket server

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    socketWriter

    property any socketWriter

    The socket writer class

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    closeConnection

    public any closeConnection()

    Close Connection

    getSocket

    public string getSocket()

    getSocketWriter

    public string getSocketWriter()

    logMessage

    public any logMessage(LogEvent logEvent)

    Write an entry into the appender. You must implement this method yourself.

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

    onRegistration

    public any onRegistration()

    When registration occurs

    Overrides:
    onRegistration in class AbstractAppender

    onUnRegistration

    public any onUnRegistration()

    When Unregistration occurs

    Overrides:
    onUnRegistration in class AbstractAppender

    openConnection

    private any openConnection()

    Open a socket connection

    Throws:
    SocketAppender.ConnectionException

    setSocket

    public any setSocket(any socket)

    Parameters:
    socket

    setSocketWriter

    public any setSocketWriter(any socketWriter)

    Parameters:
    socketWriter