note
VeloxDB is still in beta and APIs are subject to change. We are in the process of completing the documentation, so some sections may be incomplete or empty at this time.
Class APITrace
Provides methods to trace execution of the user APIs.
Inherited Members
Namespace: VeloxDB .Common
Assembly: vlxc.dll
Syntax
public static class APITrace
Properties
Level
Get the current trace level.
Declaration
public static TraceLevel Level { get; }
Property Value
Type | Description |
---|---|
Trace |
Methods
Debug(string)
Writes a debug message.
Declaration
public static void Debug(string message)
Parameters
Type | Name | Description |
---|---|---|
string | message | Message text. |
Debug(string, params object[])
Writes a formated debug message.
Declaration
public static void Debug(string format, params object[] args)
Parameters
Debug<T1>(string, T1)
Writes a formated debug message.
Declaration
public static void Debug<T1>(string format, T1 v1)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
Type Parameters
Name | Description |
---|---|
T1 |
Debug<T1, T2>(string, T1, T2)
Writes a formated debug message.
Declaration
public static void Debug<T1, T2>(string format, T1 v1, T2 v2)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 |
Debug<T1, T2, T3>(string, T1, T2, T3)
Writes a formated debug message.
Declaration
public static void Debug<T1, T2, T3>(string format, T1 v1, T2 v2, T3 v3)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 |
Debug<T1, T2, T3, T4>(string, T1, T2, T3, T4)
Writes a formated debug message.
Declaration
public static void Debug<T1, T2, T3, T4>(string format, T1 v1, T2 v2, T3 v3, T4 v4)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
T4 | v4 | Fourth format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 | |
T4 |
Error(Exception)
Writes an exception as an error message.
Declaration
public static void Error(Exception e)
Parameters
Type | Name | Description |
---|---|---|
Exception | e | The exception. |
Error(Exception, string, params object[])
Writes an exception as an error message with additional user provided message.
Declaration
public static void Error(Exception e, string format, params object[] args)
Parameters
Type | Name | Description |
---|---|---|
Exception | e | The exception. |
string | format | Message format string. |
object[] | args | Format arguments. |
Error(string)
Writes an error message.
Declaration
public static void Error(string message)
Parameters
Type | Name | Description |
---|---|---|
string | message | Message text. |
Error(string, params object[])
Writes a formated error message.
Declaration
public static void Error(string format, params object[] args)
Parameters
Error<T1>(string, T1)
Writes a formated error message.
Declaration
public static void Error<T1>(string format, T1 v1)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
Type Parameters
Name | Description |
---|---|
T1 |
Error<T1, T2>(string, T1, T2)
Writes a formated error message.
Declaration
public static void Error<T1, T2>(string format, T1 v1, T2 v2)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 |
Error<T1, T2, T3>(string, T1, T2, T3)
Writes a formated error message.
Declaration
public static void Error<T1, T2, T3>(string format, T1 v1, T2 v2, T3 v3)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 |
Error<T1, T2, T3, T4>(string, T1, T2, T3, T4)
Writes a formated error message.
Declaration
public static void Error<T1, T2, T3, T4>(string format, T1 v1, T2 v2, T3 v3, T4 v4)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
T4 | v4 | Fourth format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 | |
T4 |
Info(string)
Writes an information message.
Declaration
public static void Info(string message)
Parameters
Type | Name | Description |
---|---|---|
string | message | Message text. |
Info(string, params object[])
Writes a formated info message.
Declaration
public static void Info(string format, params object[] args)
Parameters
Info<T1>(string, T1)
Writes a formated information message.
Declaration
public static void Info<T1>(string format, T1 v1)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
Type Parameters
Name | Description |
---|---|
T1 |
Info<T1, T2>(string, T1, T2)
Writes a formated information message.
Declaration
public static void Info<T1, T2>(string format, T1 v1, T2 v2)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 |
Info<T1, T2, T3>(string, T1, T2, T3)
Writes a formated information message.
Declaration
public static void Info<T1, T2, T3>(string format, T1 v1, T2 v2, T3 v3)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 |
Info<T1, T2, T3, T4>(string, T1, T2, T3, T4)
Writes a formated information message.
Declaration
public static void Info<T1, T2, T3, T4>(string format, T1 v1, T2 v2, T3 v3, T4 v4)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
T4 | v4 | Fourth format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 | |
T4 |
ShouldTrace(TraceLevel)
Gets the value indicating whether a trace message whould be collected given the current trace level.
Declaration
public static bool ShouldTrace(TraceLevel level)
Parameters
Type | Name | Description |
---|---|---|
Trace |
level |
Returns
Type | Description |
---|---|
bool |
Verbose(string)
Writes a verbose message.
Declaration
public static void Verbose(string message)
Parameters
Type | Name | Description |
---|---|---|
string | message | Message text. |
Verbose<T1>(string, T1)
Writes a formated verbose message.
Declaration
public static void Verbose<T1>(string format, T1 v1)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
Type Parameters
Name | Description |
---|---|
T1 |
Verbose<T1, T2>(string, T1, T2)
Writes a formated verbose message.
Declaration
public static void Verbose<T1, T2>(string format, T1 v1, T2 v2)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 |
Verbose<T1, T2, T3>(string, T1, T2, T3)
Writes a formated verbose message.
Declaration
public static void Verbose<T1, T2, T3>(string format, T1 v1, T2 v2, T3 v3)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 |
Verbose<T1, T2, T3, T4>(string, T1, T2, T3, T4)
Writes a formated verbose message.
Declaration
public static void Verbose<T1, T2, T3, T4>(string format, T1 v1, T2 v2, T3 v3, T4 v4)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
T4 | v4 | Fourth format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 | |
T4 |
Warning(string)
Writes a warning message.
Declaration
public static void Warning(string message)
Parameters
Type | Name | Description |
---|---|---|
string | message | Message text. |
Warning(string, params object[])
Writes a formated warning message.
Declaration
public static void Warning(string format, params object[] args)
Parameters
Warning<T1>(string, T1)
Writes a formated warning message.
Declaration
public static void Warning<T1>(string format, T1 v1)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
Type Parameters
Name | Description |
---|---|
T1 |
Warning<T1, T2>(string, T1, T2)
Writes a formated warning message.
Declaration
public static void Warning<T1, T2>(string format, T1 v1, T2 v2)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 |
Warning<T1, T2, T3>(string, T1, T2, T3)
Writes a formated warning message.
Declaration
public static void Warning<T1, T2, T3>(string format, T1 v1, T2 v2, T3 v3)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 |
Warning<T1, T2, T3, T4>(string, T1, T2, T3, T4)
Writes a formated warning message.
Declaration
public static void Warning<T1, T2, T3, T4>(string format, T1 v1, T2 v2, T3 v3, T4 v4)
Parameters
Type | Name | Description |
---|---|---|
string | format | Format string. |
T1 | v1 | First format argument. |
T2 | v2 | Second format argument. |
T3 | v3 | Third format argument. |
T4 | v4 | Fourth format argument. |
Type Parameters
Name | Description |
---|---|
T1 | |
T2 | |
T3 | |
T4 |