The class that implements ILogger can also be coded to log information originating from the application itself. In this way you can use one single logger to record information originating from both the application and the StreamLink.NET library.

The ILogger interface defines one method named Log(SourceLevels, String, String) with various overloads. The first parameter of Log() is a Microsoft .NET SourceLevels enum which identifies the severity of the message. The second parameter is either a String identifying the category associated with the log message, or a [!:String[]] that identifies several such categories. An example of a category is RawData; log messages with this category contain RTTP messages. For the list of logging categories, see LoggingCategories.

Both the SourceLevels enum and the category can be used to filter the messages allowing the user to log only information relating to severity and/or an associated category.

CopyC#

using System;
using System.Collections.Generic;
using System.Text;

using Caplin.StreamLink;
using Caplin.StreamLink.Logging;
using System.Diagnostics;
using Caplin.StreamLink.Authentication;

namespace StreamLinkExamples.Basics
{
    /// <summary>
    /// Example inner class that implements ILogger and
    /// a an outline of how it may be used.
    /// </summary>
    public class SettingUpALogger
    {
        /// <summary>
        /// Example of a class that implements ILogger and
        /// a an outline of how it may be used.
        /// </summary>
        public static void SettingUpALoggerExample()
        {
            StreamLink myStreamLink = new StreamLink();

            // Set the logger property to start using the console logger
            myStreamLink.Logger = new ConsoleLogger();
        }
    }
}

Thread Safety

The ILogger methods are not called on a dedicated worker thread. Therefore if the logger is likely to perform any sort of intense execution it is recommended that the API user executes this in a separate thread.