Lean  $LEAN_TAG$
QuantConnect.Brokerages.BrokerageMessageEvent Class Reference

Represents a message received from a brokerage More...

Public Member Functions

 BrokerageMessageEvent (BrokerageMessageType type, int code, string message)
 Initializes a new instance of the BrokerageMessageEvent class More...
 
 BrokerageMessageEvent (BrokerageMessageType type, string code, string message)
 Initializes a new instance of the BrokerageMessageEvent class More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Static Public Member Functions

static BrokerageMessageEvent Disconnected (string message)
 Creates a new BrokerageMessageEvent to represent a disconnect message More...
 
static BrokerageMessageEvent Reconnected (string message)
 Creates a new BrokerageMessageEvent to represent a reconnect message More...
 

Properties

BrokerageMessageType Type [get]
 Gets the type of brokerage message More...
 
string Code [get]
 Gets the brokerage specific code for this message, zero if no code was specified More...
 
string Message [get]
 Gets the message text received from the brokerage More...
 

Detailed Description

Represents a message received from a brokerage

Definition at line 21 of file BrokerageMessageEvent.cs.

Constructor & Destructor Documentation

◆ BrokerageMessageEvent() [1/2]

QuantConnect.Brokerages.BrokerageMessageEvent.BrokerageMessageEvent ( BrokerageMessageType  type,
int  code,
string  message 
)

Initializes a new instance of the BrokerageMessageEvent class

Parameters
typeThe type of brokerage message
codeThe brokerage specific code
messageThe message text received from the brokerage

Definition at line 44 of file BrokerageMessageEvent.cs.

Here is the caller graph for this function:

◆ BrokerageMessageEvent() [2/2]

QuantConnect.Brokerages.BrokerageMessageEvent.BrokerageMessageEvent ( BrokerageMessageType  type,
string  code,
string  message 
)

Initializes a new instance of the BrokerageMessageEvent class

Parameters
typeThe type of brokerage message
codeThe brokerage specific code
messageThe message text received from the brokerage

Definition at line 57 of file BrokerageMessageEvent.cs.

Member Function Documentation

◆ Disconnected()

static BrokerageMessageEvent QuantConnect.Brokerages.BrokerageMessageEvent.Disconnected ( string  message)
static

Creates a new BrokerageMessageEvent to represent a disconnect message

Parameters
messageThe message from the brokerage
Returns
A brokerage disconnect message

Definition at line 69 of file BrokerageMessageEvent.cs.

Here is the call graph for this function:

◆ Reconnected()

static BrokerageMessageEvent QuantConnect.Brokerages.BrokerageMessageEvent.Reconnected ( string  message)
static

Creates a new BrokerageMessageEvent to represent a reconnect message

Parameters
messageThe message from the brokerage
Returns
A brokerage reconnect message

Definition at line 79 of file BrokerageMessageEvent.cs.

Here is the call graph for this function:

◆ ToString()

override string QuantConnect.Brokerages.BrokerageMessageEvent.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 91 of file BrokerageMessageEvent.cs.

Property Documentation

◆ Type

BrokerageMessageType QuantConnect.Brokerages.BrokerageMessageEvent.Type
get

Gets the type of brokerage message

Definition at line 26 of file BrokerageMessageEvent.cs.

◆ Code

string QuantConnect.Brokerages.BrokerageMessageEvent.Code
get

Gets the brokerage specific code for this message, zero if no code was specified

Definition at line 31 of file BrokerageMessageEvent.cs.

◆ Message

string QuantConnect.Brokerages.BrokerageMessageEvent.Message
get

Gets the message text received from the brokerage

Definition at line 36 of file BrokerageMessageEvent.cs.


The documentation for this class was generated from the following file: