Skip to content

Channel

QuantConnect.Data.Channel

Channel(
    channel_name: str,
    symbol: Union[Symbol, str, BaseContract],
)

Bases: Object

Represents a subscription channel

Creates an instance of subscription channel

Parameters:

Name Type Description Default
channel_name str

Socket channel name

required
symbol Union[Symbol, str, BaseContract]

Associated symbol

required

single

single: str = 'common'

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

name

name: str

The name of the channel

symbol

symbol: Symbol

The ticker symbol of the channel

equals

equals(obj: Any) -> bool
equals(other: Channel) -> bool

Signature descriptions:

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

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

Parameters:

Name Type Description Default
obj Optional[Any]

The object to compare with the current object.

None
other Optional[Channel]

An object to compare with this object.

None

Returns:

Type Description
bool

Depends on the signature used. Case 1: [true if the specified object is equal to the current object; otherwise, false.]; Case 2: [true if the current object is equal to the other parameter; otherwise, false.]

get_hash_code

get_hash_code() -> int

Serves as the default hash function.

Returns:

Type Description
int

A hash code for the current object.