LogBuffer< TBufferSize > Class Template Reference

#include <loggingcentral.h>

Collaboration diagram for LogBuffer< TBufferSize >:

Public Member Functions
void	writeLine (LogLineBuffer *line)
void	writeLogger (Logging *logging)
size_t	length () const
void	reset ()
const char *	get () const

Private Member Functions
void	writeInternal (const char *buffer)

Private Attributes
char	m_buffer [TBufferSize]
char *	m_writePtr = m_buffer

Detailed Description

template<size_t TBufferSize>
class LogBuffer< TBufferSize >

Definition at line 44 of file loggingcentral.h.

Member Function Documentation

get()

template<size_t TBufferSize>

const char * LogBuffer< TBufferSize >::get

(

)

const

Definition at line 54 of file loggingcentral.cpp.

                                              {
    return m_buffer;
}

Referenced by swapOutputBuffers().

Here is the caller graph for this function:

length()

template<size_t TBufferSize>

size_t LogBuffer< TBufferSize >::length

(

)

const

Definition at line 43 of file loggingcentral.cpp.

                                            {
    return m_writePtr - m_buffer;
}

Referenced by swapOutputBuffers().

Here is the caller graph for this function:

reset()

template<size_t TBufferSize>

void LogBuffer< TBufferSize >::reset

(

)

Definition at line 48 of file loggingcentral.cpp.

                                   {
    m_writePtr = m_buffer;
    *m_writePtr = '\0';
}

Referenced by swapOutputBuffers().

Here is the caller graph for this function:

writeInternal()

template<size_t TBufferSize>

void LogBuffer< TBufferSize >::writeInternal ( const char *  buffer )

private

Definition at line 59 of file loggingcentral.cpp.

                                                             {
    size_t len = std::strlen(buffer);
    // leave one byte extra at the end to guarantee room for a null terminator
    size_t available = TBufferSize - length() - 1;
 
    // If we can't fit the whole thing, write as much as we can
    len = minI(available, len);
    // Ensure the output buffer is always null terminated (in case we did a partial write)
    *(m_writePtr + len) = '\0';
    memcpy(m_writePtr, buffer, len);
    m_writePtr += len;
}

writeLine()

template<size_t TBufferSize>

void LogBuffer< TBufferSize >::writeLine

(

LogLineBuffer *

line

)

Definition at line 33 of file loggingcentral.cpp.

                                                          {
    writeInternal(line->buffer);
}

writeLogger()

template<size_t TBufferSize>

void LogBuffer< TBufferSize >::writeLogger

(

Logging *

logging

)

Definition at line 38 of file loggingcentral.cpp.

                                                          {
    writeInternal(logging->buffer);
}

Referenced by scheduleLogging().

Here is the caller graph for this function:

Field Documentation

m_buffer

template<size_t TBufferSize>

char LogBuffer< TBufferSize >::m_buffer[TBufferSize]

private

Definition at line 58 of file loggingcentral.h.

m_writePtr

template<size_t TBufferSize>

char* LogBuffer< TBufferSize >::m_writePtr = m_buffer

private

Definition at line 59 of file loggingcentral.h.

---

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

• util/loggingcentral.h
• util/loggingcentral.cpp