Classes | Public Member Functions | Static Public Member Functions | Public Attributes

RolloverDescription Class Reference

Inherits log4cxx::helpers::ObjectImpl.

List of all members.

Classes

class  ClazzRolloverDescription

Public Member Functions

virtual const helpers::ClassgetClass () const
const void * cast (const helpers::Class &clazz) const
bool instanceof (const helpers::Class &clazz) const
 RolloverDescription ()
 RolloverDescription (const LogString &activeFileName, const bool append, const ActionPtr &synchronous, const ActionPtr &asynchronous)
 Create new instance.
LogString getActiveFileName () const
 Active log file name after rollover.
bool getAppend () const
ActionPtr getSynchronous () const
 Action to be completed after close of current active log file before returning control to caller.
ActionPtr getAsynchronous () const
 Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.

Static Public Member Functions

static const helpers::ClassgetStaticClass ()
static const
log4cxx::helpers::ClassRegistration
registerClass ()

Public Attributes

LogString activeFileName
 Active log file name after rollover.
bool append
 Should active file be opened for appending.
ActionPtr synchronous
 Action to be completed after close of current active log file before returning control to caller.
ActionPtr asynchronous
 Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.

Constructor & Destructor Documentation

RolloverDescription ( const LogString activeFileName,
const bool  append,
const ActionPtr synchronous,
const ActionPtr asynchronous 
)

Create new instance.

Parameters:
activeFileName active log file name after rollover, may not be null.
append true if active log file after rollover should be opened for appending.
synchronous action to be completed after close of current active log file, may be null.
asynchronous action to be completed after close of current active log file and before next rollover attempt.

Member Function Documentation

const void* cast ( const helpers::Class clazz  )  const [inline, virtual]

Implements Object.

LogString getActiveFileName (  )  const

Active log file name after rollover.

Returns:
active log file name after rollover.
bool getAppend (  )  const
ActionPtr getAsynchronous (  )  const

Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.

Returns:
action, may be null.
virtual const helpers::Class& getClass (  )  const [virtual]

Reimplemented from Object.

static const helpers::Class& getStaticClass (  )  [static]

Reimplemented from Object.

ActionPtr getSynchronous (  )  const

Action to be completed after close of current active log file before returning control to caller.

Returns:
action, may be null.
bool instanceof ( const helpers::Class clazz  )  const [inline, virtual]

Implements Object.

static const log4cxx::helpers::ClassRegistration& registerClass (  )  [static]

Reimplemented from Object.


Member Data Documentation

Active log file name after rollover.

bool append

Should active file be opened for appending.

Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.

Action to be completed after close of current active log file before returning control to caller.


The documentation for this class was generated from the following file: