Lean  $LEAN_TAG$
QuantConnect.Data.Channel Class Reference

Represents a subscription channel More...

Public Member Functions

 Channel (string channelName, Symbol symbol)
 Creates an instance of subscription channel More...
 
bool Equals (Channel other)
 Indicates whether the current object is equal to another object of the same type. More...
 
override bool Equals (object obj)
 Determines whether the specified object is equal to the current object. More...
 
override int GetHashCode ()
 Serves as the default hash function. More...
 

Static Public Attributes

static string Single = "common"
 Represents an internal channel name for all brokerage channels in case we don't differentiate them More...
 

Properties

string Name [get]
 The name of the channel More...
 
Symbol Symbol [get]
 The ticker symbol of the channel More...
 

Detailed Description

Represents a subscription channel

Definition at line 24 of file Channel.cs.

Constructor & Destructor Documentation

◆ Channel()

QuantConnect.Data.Channel.Channel ( string  channelName,
Symbol  symbol 
)

Creates an instance of subscription channel

Parameters
channelNameSocket channel name
symbolAssociated symbol

Definition at line 47 of file Channel.cs.

Member Function Documentation

◆ Equals() [1/2]

bool QuantConnect.Data.Channel.Equals ( Channel  other)

Indicates whether the current object is equal to another object of the same type.

Parameters
otherAn object to compare with this object.
Returns
true if the current object is equal to the other parameter; otherwise, false.

Definition at line 70 of file Channel.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Equals() [2/2]

override bool QuantConnect.Data.Channel.Equals ( object  obj)

Determines whether the specified object is equal to the current object.

Parameters
objThe object to compare with the current object.
Returns
true if the specified object is equal to the current object; otherwise, false.

Definition at line 84 of file Channel.cs.

Here is the call graph for this function:

◆ GetHashCode()

override int QuantConnect.Data.Channel.GetHashCode ( )

Serves as the default hash function.

Returns
A hash code for the current object.

Definition at line 95 of file Channel.cs.

Here is the call graph for this function:

Member Data Documentation

◆ Single

string QuantConnect.Data.Channel.Single = "common"
static

Represents an internal channel name for all brokerage channels in case we don't differentiate them

Definition at line 30 of file Channel.cs.

Property Documentation

◆ Name

string QuantConnect.Data.Channel.Name
get

The name of the channel

Definition at line 35 of file Channel.cs.

◆ Symbol

Symbol QuantConnect.Data.Channel.Symbol
get

The ticker symbol of the channel

Definition at line 40 of file Channel.cs.


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