ACE_Log_Record Class Reference

Defines the structure of an ACE logging record. More...

#include <Log_Record.h>

Collaboration diagram for ACE_Log_Record:

Public Types
enum	{ MAXLOGMSGLEN = ACE_MAXLOGMSGLEN+1 , ALIGN_WORDB = 8 , VERBOSE_LEN = 128 , MAXVERBOSELOGMSGLEN = VERBOSE_LEN + MAXLOGMSGLEN }

Public Member Functions
	ACE_Log_Record ()
	ACE_Log_Record (ACE_Log_Priority lp, time_t time_stamp, long pid)
	ACE_Log_Record (ACE_Log_Priority lp, const ACE_Time_Value &time_stamp, long pid)
	~ACE_Log_Record ()
	Default dtor.
int	print (const ACE_TCHAR host_name[], u_long verbose_flag, FILE *fp=stderr)
int	print (const ACE_TCHAR host_name[], u_long verbose_flag, ACE_OSTREAM_TYPE &stream)
int	format_msg (const ACE_TCHAR host_name[], u_long verbose_flag, ACE_TCHAR *verbose_msg, size_t verbose_msg_size)
ACE_UINT32	type () const
	Get the type of the Log_Record.
void	type (ACE_UINT32)
	Set the type of the Log_Record.
ACE_Log_Category_TSS *	category () const
	Get the category of the Log_Record.
void	category (ACE_Log_Category_TSS *)
	Set the category of the Log_Record.
u_long	priority () const
void	priority (u_long num)
long	length () const
void	length (long)
ACE_Time_Value	time_stamp () const
	Get the time stamp of the Log_Record.
void	time_stamp (const ACE_Time_Value &ts)
	Set the time stamp of the Log_Record.
long	pid () const
	Get the process id of the Log_Record.
void	pid (long)
	Set the process id of the Log_Record.
const ACE_TCHAR *	msg_data () const
	Get the message data of the Log_Record.
int	msg_data (const ACE_TCHAR *data)
size_t	msg_data_len () const
void	dump () const
	Dump the state of an object.

Static Public Member Functions
static const ACE_TCHAR *	priority_name (ACE_Log_Priority p)
static void	priority_name (ACE_Log_Priority p, const ACE_TCHAR *name)
	IMPORTANT: name must be a statically allocated const ACE_TCHAR*.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Private Member Functions
void	round_up ()
	Round up to the alignment restrictions.
	ACE_Log_Record (const ACE_Log_Record &)=delete
ACE_Log_Record &	operator= (const ACE_Log_Record &)=delete
	ACE_Log_Record (ACE_Log_Record &&)=delete
ACE_Log_Record &	operator= (ACE_Log_Record &&rhs)=delete

Private Attributes
ACE_INT32	length_
ACE_UINT32	type_
	Type of logging record.
time_t	secs_
	Time that the logging record was generated.
ACE_UINT32	usecs_
ACE_UINT32	pid_
	Id of process that generated the logging record.
ACE_TCHAR *	msg_data_
	Logging record data.
size_t	msg_data_size_
	Allocated size of msg_data_ in ACE_TCHARs.
ACE_Log_Category_TSS *	category_

Detailed Description

Defines the structure of an ACE logging record.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MAXLOGMSGLEN	Maximum size of a logging message.
ALIGN_WORDB	Most restrictive alignment.
VERBOSE_LEN	Size used by verbose mode. 20 (date) + 15 (host_name) + 10 (pid) + 10 (type) 4 (@) ... + ? (progname)
MAXVERBOSELOGMSGLEN	Maximum size of a logging message with the verbose headers.

Constructor & Destructor Documentation

ACE_Log_Record() [1/5]

ACE_Log_Record::ACE_Log_Record

(

)

Create a Log_Record and set its priority, time stamp, and process id.

ACE_Log_Record() [2/5]

ACE_Log_Record::ACE_Log_Record	(	ACE_Log_Priority	lp,
		time_t	time_stamp,
		long	pid )

ACE_Log_Record() [3/5]

ACE_Log_Record::ACE_Log_Record	(	ACE_Log_Priority	lp,
		const ACE_Time_Value &	time_stamp,
		long	pid )

~ACE_Log_Record()

ACE_Log_Record::~ACE_Log_Record ( )

inline

Default dtor.

ACE_Log_Record() [4/5]

ACE_Log_Record::ACE_Log_Record ( const ACE_Log_Record & )

privatedelete

ACE_Log_Record() [5/5]

ACE_Log_Record::ACE_Log_Record ( ACE_Log_Record && )

privatedelete

Member Function Documentation

category() [1/2]

ACE_Log_Category_TSS * ACE_Log_Record::category ( ) const

inline

Get the category of the Log_Record.

category() [2/2]

void ACE_Log_Record::category ( ACE_Log_Category_TSS * t )

inline

Set the category of the Log_Record.

dump()

void ACE_Log_Record::dump

(

)

const

Dump the state of an object.

format_msg()

int ACE_Log_Record::format_msg	(	const ACE_TCHAR	host_name[],
		u_long	verbose_flag,
		ACE_TCHAR *	verbose_msg,
		size_t	verbose_msg_size )

length() [1/2]

long ACE_Log_Record::length ( ) const

inline

Get the total length of the Log_Record, which includes the size of the various data member fields.

length() [2/2]

void ACE_Log_Record::length ( long l )

inline

Set the total length of the Log_Record, which needs to account for the size of the various data member fields.

msg_data() [1/2]

const ACE_TCHAR * ACE_Log_Record::msg_data ( ) const

inline

Get the message data of the Log_Record.

msg_data() [2/2]

int ACE_Log_Record::msg_data

(

const ACE_TCHAR *

data

)

Set the message data of the record. If data is longer than the current msg_data_ buffer, a new msg_data_ buffer is allocated to fit. If such a reallocation fails, this method returns -1, else 0.

msg_data_len()

size_t ACE_Log_Record::msg_data_len ( ) const

inline

Get the size of the message data of the Log_Record, including a byte for the NUL.

operator=() [1/2]

ACE_Log_Record & ACE_Log_Record::operator= ( ACE_Log_Record && rhs )

privatedelete

operator=() [2/2]

ACE_Log_Record & ACE_Log_Record::operator= ( const ACE_Log_Record & )

privatedelete

pid() [1/2]

long ACE_Log_Record::pid ( ) const

inline

Get the process id of the Log_Record.

pid() [2/2]

void ACE_Log_Record::pid ( long p )

inline

Set the process id of the Log_Record.

print() [1/2]

int ACE_Log_Record::print	(	const ACE_TCHAR	host_name[],
		u_long	verbose_flag,
		ACE_OSTREAM_TYPE &	stream )

Write the contents of the logging record to the appropriate stream if the corresponding type is enabled.

print() [2/2]

int ACE_Log_Record::print	(	const ACE_TCHAR	host_name[],
		u_long	verbose_flag,
		FILE *	fp = stderr )

Write the contents of the logging record to the appropriate FILE if the corresponding type is enabled.

priority() [1/2]

u_long ACE_Log_Record::priority

(

)

const

Get the priority of the Log_Record <type_>. This is computed as the base 2 logarithm of <type_> (which must be a power of 2, as defined by the enums in ACE_Log_Priority).

priority() [2/2]

void ACE_Log_Record::priority

(

u_long

num

)

Set the priority of the Log_Record <type_> (which must be a power of 2, as defined by the enums in ACE_Log_Priority).

priority_name() [1/2]

const ACE_TCHAR * ACE_Log_Record::priority_name ( ACE_Log_Priority p )

static

Returns a character array with the string form of the ACE_Log_Priority parameter. This is used for the verbose printing format.

priority_name() [2/2]

void ACE_Log_Record::priority_name ( ACE_Log_Priority p, const ACE_TCHAR * name )

static

IMPORTANT: name must be a statically allocated const ACE_TCHAR*.

round_up()

void ACE_Log_Record::round_up ( )

private

Round up to the alignment restrictions.

time_stamp() [1/2]

ACE_Time_Value ACE_Log_Record::time_stamp ( ) const

inline

Get the time stamp of the Log_Record.

time_stamp() [2/2]

void ACE_Log_Record::time_stamp ( const ACE_Time_Value & ts )

inline

Set the time stamp of the Log_Record.

type() [1/2]

ACE_UINT32 ACE_Log_Record::type ( ) const

inline

Get the type of the Log_Record.

type() [2/2]

void ACE_Log_Record::type ( ACE_UINT32 t )

inline

Set the type of the Log_Record.

Member Data Documentation

ACE_ALLOC_HOOK_DECLARE

ACE_Log_Record::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

category_

ACE_Log_Category_TSS* ACE_Log_Record::category_

private

length_

ACE_INT32 ACE_Log_Record::length_

private

Total length of the logging record in bytes. This field must come first in order for various IPC framing mechanisms to work correctly. In addition, the field must be an ACE_INT32 in order to be passed portable across platforms.

msg_data_

ACE_TCHAR* ACE_Log_Record::msg_data_

private

Logging record data.

msg_data_size_

size_t ACE_Log_Record::msg_data_size_

private

Allocated size of msg_data_ in ACE_TCHARs.

pid_

ACE_UINT32 ACE_Log_Record::pid_

private

Id of process that generated the logging record.

secs_

time_t ACE_Log_Record::secs_

private

Time that the logging record was generated.

type_

ACE_UINT32 ACE_Log_Record::type_

private

Type of logging record.

usecs_

ACE_UINT32 ACE_Log_Record::usecs_

private

---

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

• Log_Record.h
• Log_Record.cpp
• Log_Record.inl