Class ConnectionRequestContext

Request connection

See

http://www.bittorrent.org/beps/bep_0015.html UDP connections

Hierarchy (View Summary)

RequestContext<IConnectionRequestPayload, ConnectionRequestContextSendOptions>
- ConnectionRequestContext

Implements

IConnectionRequestContext

Index

Constructors

Properties

connection payload response source

Accessors

action connectionId isAnnounce isConnect isScrape isSourceHTTP isSourceUDP sent transactionId

Methods

[inspectCustomData] send toJSON

Constructors

constructor

new ConnectionRequestContext(
options: IRequestContextOptions,
): ConnectionRequestContext
Parameters
- options: IRequestContextOptions
Returns ConnectionRequestContext
Inherited from RequestContext.constructor
- Defined in contexts/requests/context.ts:25

Properties

`Protected`connection

connection: ConnectionContextUnion

`Protected`payload

payload: IConnectionRequestPayload

response

response: ConnectionRequestContextSendOptions = ...

source

source: RequestSource

Accessors

action

get action(): CONNECT
Current action

Returns CONNECT
Implementation of IConnectionRequestContext.action
Overrides RequestContext.action
- Defined in contexts/requests/connection.ts:14

connectionId

get connectionId(): bigint
Returns bigint
- Defined in contexts/requests/connection.ts:18

isAnnounce

get isAnnounce(): boolean
The current action is "announce"

Returns boolean
Implementation of IConnectionRequestContext.isAnnounce
Inherited from RequestContext.isAnnounce
- Defined in contexts/requests/context.ts:39

isConnect

get isConnect(): boolean
The current action is "connect"

Returns boolean
Implementation of IConnectionRequestContext.isConnect
Inherited from RequestContext.isConnect
- Defined in contexts/requests/context.ts:35

isScrape

get isScrape(): boolean
The current action is "scrape"

Returns boolean
Implementation of IConnectionRequestContext.isScrape
Inherited from RequestContext.isScrape
- Defined in contexts/requests/context.ts:43

isSourceHTTP

get isSourceHTTP(): boolean
The request source is HTTP

Returns boolean
Implementation of IConnectionRequestContext.isSourceHTTP
Inherited from RequestContext.isSourceHTTP
- Defined in contexts/requests/context.ts:47

isSourceUDP

get isSourceUDP(): boolean
The request source is UDP

Returns boolean
Implementation of IConnectionRequestContext.isSourceUDP
Inherited from RequestContext.isSourceUDP
- Defined in contexts/requests/context.ts:51

sent

get sent(): boolean
Has an answer been sent

Returns boolean
Implementation of IConnectionRequestContext.sent
Inherited from RequestContext.sent
- Defined in contexts/requests/context.ts:55

transactionId

get transactionId(): number
Returns the transaction ID (only UDP)

Returns number
Implementation of IConnectionRequestContext.transactionId
Inherited from RequestContext.transactionId
- Defined in contexts/requests/context.ts:59

Methods

[inspectCustomData]

"[inspectCustomData]"(): object
Returns the custom data

Returns object
Overrides RequestContext.[inspectCustomData]
- Defined in contexts/requests/connection.ts:32

send

send(payload: ConnectionRequestContextSendOptions): Promise<void>
Sends a response
Parameters
- payload: ConnectionRequestContextSendOptions
Returns Promise<void>
Implementation of IConnectionRequestContext.send
- Defined in contexts/requests/connection.ts:22

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from RequestContext.toJSON
- Defined in contexts/requests/context.ts:67