BrokerageMessageEvent.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
 
namespace QuantConnect.Brokerages
{
    /// <summary>
    /// Represents a message received from a brokerage
    /// </summary>
    public class BrokerageMessageEvent
    {
        /// <summary>
        /// Gets the type of brokerage message
        /// </summary>
        public BrokerageMessageType Type { get; private set; }
 
        /// <summary>
        /// Gets the brokerage specific code for this message, zero if no code was specified
        /// </summary>
        public string Code { get; private set; }
 
        /// <summary>
        /// Gets the message text received from the brokerage
        /// </summary>
        public string Message { get; private set; }
 
        /// <summary>
        /// Initializes a new instance of the BrokerageMessageEvent class
        /// </summary>
        /// <param name="type">The type of brokerage message</param>
        /// <param name="code">The brokerage specific code</param>
        /// <param name="message">The message text received from the brokerage</param>
        public BrokerageMessageEvent(BrokerageMessageType type, int code, string message)
        {
            Type = type;
            Code = code.ToStringInvariant();
            Message = message;
        }
 
        /// <summary>
        /// Initializes a new instance of the BrokerageMessageEvent class
        /// </summary>
        /// <param name="type">The type of brokerage message</param>
        /// <param name="code">The brokerage specific code</param>
        /// <param name="message">The message text received from the brokerage</param>
        public BrokerageMessageEvent(BrokerageMessageType type, string code, string message)
        {
            Type = type;
            Code = code;
            Message = message;
        }
 
        /// <summary>
        /// Creates a new <see cref="BrokerageMessageEvent"/> to represent a disconnect message
        /// </summary>
        /// <param name="message">The message from the brokerage</param>
        /// <returns>A brokerage disconnect message</returns>
        public static BrokerageMessageEvent Disconnected(string message)
        {
            return new BrokerageMessageEvent(BrokerageMessageType.Disconnect, Messages.BrokerageMessageEvent.DisconnectCode, message);
        }
 
        /// <summary>
        /// Creates a new <see cref="BrokerageMessageEvent"/> to represent a reconnect message
        /// </summary>
        /// <param name="message">The message from the brokerage</param>
        /// <returns>A brokerage reconnect message</returns>
        public static BrokerageMessageEvent Reconnected(string message)
        {
            return new BrokerageMessageEvent(BrokerageMessageType.Reconnect, Messages.BrokerageMessageEvent.ReconnectCode, message);
        }
 
        /// <summary>
        /// Returns a string that represents the current object.
        /// </summary>
        /// <returns>
        /// A string that represents the current object.
        /// </returns>
        /// <filterpriority>2</filterpriority>
        public override string ToString()
        {
            return Messages.BrokerageMessageEvent.ToString(this);
        }
    }
}