JSRDotNETSDK Reference

# JSRDotNET_Logger Members

JSRDotNET_Logger Class Methods Fields Properties See Also

A general logger class.

The following tables list the members exposed by the JSRDotNET_Logger type.

Properties

| Name | Description
--- | --- | ---
| IncludeThreadIds | Gets or sets a value indicating whether the thread identifiers should be included.
| IncludeTimestamps | Gets or sets a value indicating whether the timestamps should be included.
| LogLevel | Gets or sets the log level.

Top
Methods

| Name | Description
--- | --- | ---
| BufferDump<T> | Returns a string representation of the provided buffer
| DequeueEarliestLogEntry | The current log lines can be read by calling this repeatedly until a null is returned. Lines are removed from the in-memory queue of log lines.
| DequeueEarliestLogline | The current log lines can be read by calling this repeatedly until a null is returned. Lines are removed from the in-memory queue of log lines.
| DumpBytes |
| Equals | (Overloaded) Determines whether the specified Object is equal to the current Object. (inherited from Object).
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object).
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object).
| GetLogCount | Gets the current count of log lines.
| GetType | (Overloaded) Gets the Type of the current instance. (inherited from Object).
| MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object).
| ReferenceEquals | Determines whether the specified Object instances are the same instance. (inherited from Object).
| SetCallback | Callback that will be callled when a new log entry is written. NOTE: When a callback is set, all of the queued log lines will be pushed to this callback.
| ToString | Returns a String that represents the current Object. (inherited from Object).
| WriteAllLinesToWriter | Writes all lines to writer, and leaves the log queue empty.
| XlateLogLevel | Sets log llevel.
| enqueueEntry | Enqueue entry.
| logData<T> | Logs a generic message with a data buffer and a message with arguments for string.Format.
| logException | (Overloaded) Logs an exception. Pulls various information including type and stack trace and enters multiple log lines into the log.
| logMessage | (Overloaded) Logs a string message for the message debug
| logMessage<T> | (Overloaded) Logs a data buffer and string message for the message debug
| logProtocol | (Overloaded) Logs a protocol string message.
| logProtocol<T> | (Overloaded) Logs a protocol string message with a data buffer and a string message.
| logstr | (Overloaded) Adds a string to the list of log lines. If log list is already at the maximum, the oldest log line is removed from the list.
| logstrDefault | (Overloaded) Adds a string to the list of log lines. If log list is already at the maximum, the oldest log line is removed from the list.
| logstrSignificant | (Overloaded) Log an important event. If the first character of the string is W, then it will go into the windows log as a warning. If it is a 'E' it would go into the event log as an error. Otherwise it is logged as information. However, the windows Event log is only added to if g_bLogEvents is true.
| logstrVerbose | (Overloaded) Adds a string to the list of log lines. If log list is already at the maximum, the oldest log line is removed from the list.

Top
Classes

| Name | Description
--- | --- | ---
| LogLine |

Top
Enumerations

| Name | Description
--- | --- | ---
| LOGLEVEL | Values that represent loglevels.

Top
Fields

| Name | Description
--- | --- | ---
| DEFAULT_Q_MAXLEN |
| EVENT_LOG_SOURCE_NAME |
| LOGNAME |
| MESSAGE_PREFIX |
| PROTOCOL_PREFIX |
| g_LogLevel |
| g_bLogEvents |
| g_bLogIncludeThreadIds |
| g_bLogIncludeTimestamps |
| g_bLogStartNeedsInitialization |
| g_callback |
| g_q |
| g_ticksLogStart |

Top
See Also

#### Reference

JSRDotNET_Logger Class
JSRDotNETSDK Namespace