Linphone.LoggingService Class Reference

Inheritance diagram for Linphone.LoggingService:

Public Member Functions
void	Debug (string message)
void	Error (string message)
void	Fatal (string message)
void	Message (string message)
void	SetLogFile (string dir, string filename, long maxSize)
void	Trace (string message)
void	Warning (string message)

Properties
LoggingServiceListener	Listener [get, set]
static Linphone.LoggingService	Instance [get]
string	Domain [get, set]
Linphone.LogLevel	LogLevel [set]
uint	LogLevelMask [get, set]
bool	StackTraceDumpsEnabled [set]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

Singleton class giving access to logging features.

It supports custom domain, writing into a file as well as several verbosity levels. The Linphone.LoggingServiceListener listener allows you to be notified each time a log is printed. As the Linphone.LoggingService is a singleton, use Linphone.LoggingService. to get it.

Member Function Documentation

void Linphone.LoggingService.Debug ( string  message )

inline

Write a LinphoneLogLevelDebug message to the logs.

Parameters

message

The log message.

void Linphone.LoggingService.Error ( string  message )

inline

Write a LinphoneLogLevelError message to the logs.

Parameters

message

The log message.

void Linphone.LoggingService.Fatal ( string  message )

inline

Write a LinphoneLogLevelFatal message to the logs.

Parameters

message

The log message.

void Linphone.LoggingService.Message ( string  message )

inline

Write a LinphoneLogLevelMessage message to the logs.

Parameters

message

The log message.

void Linphone.LoggingService.SetLogFile ( string  dir, string  filename, long  maxSize  )

inline

Enables logging in a file.

That function enables an internal log handler that writes log messages in log-rotated files.

Parameters

dir	Directory where to create the distinct parts of the log.
filename	Name of the log file.
maxSize	The maximal size of each part of the log. The log rotating is triggered each time the currently opened log part reach that limit.

void Linphone.LoggingService.Trace ( string  message )

inline

Write a LinphoneLogLevelTrace message to the logs.

Parameters

message

The log message.

void Linphone.LoggingService.Warning ( string  message )

inline

Write a LinphoneLogLevelWarning message to the logs.

Parameters

message

The log message.

Property Documentation

string Linphone.LoggingService.Domain

getset

Get the domain where application logs are written (for example with Linphone.LoggingService.Message()).

Returns

The domain where application logs are written.

Linphone.LoggingService Linphone.LoggingService.Instance

staticget

Gets the singleton logging service object.

The singleton is automatically instantiated if it hasn't been done yet.

Returns

A pointer on the Linphone.LoggingService singleton.

Linphone.LogLevel Linphone.LoggingService.LogLevel

set

Set the verbosity of the log.

For instance, a level of Linphone.LogLevel.Message will let pass fatal, error, warning and message-typed messages whereas trace and debug messages will be dumped out.

Parameters

level

the Linphone.LogLevel to set

uint Linphone.LoggingService.LogLevelMask

getset

Gets the log level mask.

Returns

the log level mask

bool Linphone.LoggingService.StackTraceDumpsEnabled

set

Allow Linphone to set handlers for catching exceptions and write the stack trace into log.

Available for Windows. It keeps old handlers.

Parameters

enable

if true global handlers will be prepend by the logger handlers. By default, it is false.

---

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

• LinphoneWrapper.cs