If you want your application to log StreamLink errors and other activity, implement the ILogger interface. The application must register the ILogger with StreamLink by setting the Logger property of the StreamLink object.

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 library.

The ILogger interface defines one method named Log(SourceLevels, String, String) with various overloads. The first argument of Log() is a SourceLevels enumeration which identifies the severity of the message. The second argument is either a String identifying the category associated with the log message, or a String array that identifies several such categories. An example of a category is RawDataIn; log messages with this category contain RTTP messages. For the list of logging categories used by StreamLink, see LoggingCategories.

Both the SourceLevels enum and the category can be used to filter the messages in the implemented Log() methods, allowing the application to only log information relating to particular severities and/or associated categories.

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();
        }
    }
}