IRCDCCTransfer

Inherits: RefCounted < Object

Represents an active or pending Direct Client-to-Client file transfer.

Description

Handles the status, metrics, tracking, and port mapping logic required to initiate or receive an outgoing DCC SEND block over the networking protocol layer safely utilizing asynchronous connections.

Tutorials

Properties

String

address

""

int

file_size

0

String

filename

""

String

local_path

""

int

port

0

String

remote_nick

""

Status

status

0

int

transferred

0

Type

type

0

bool

use_ipv6

false

Methods

Error

accept()

Error

cancel()

String

get_error_message() const

float

get_progress() const

int

get_resume_position() const

Error

reject()

void

set_resume_position(position: int)

Enumerations

enum Type: 🔗

Type TYPE_FILE_SEND = 0

There is currently no description for this enum. Please help us by contributing one!

Type TYPE_FILE_RECEIVE = 1

There is currently no description for this enum. Please help us by contributing one!

Type TYPE_CHAT = 2

There is currently no description for this enum. Please help us by contributing one!

enum Status: 🔗

Status DCC_STATUS_PENDING = 0

There is currently no description for this enum. Please help us by contributing one!

Status DCC_STATUS_CONNECTING = 1

There is currently no description for this enum. Please help us by contributing one!

Status DCC_STATUS_TRANSFERRING = 2

There is currently no description for this enum. Please help us by contributing one!

Status DCC_STATUS_COMPLETED = 3

There is currently no description for this enum. Please help us by contributing one!

Status DCC_STATUS_FAILED = 4

There is currently no description for this enum. Please help us by contributing one!

Status DCC_STATUS_CANCELLED = 5

There is currently no description for this enum. Please help us by contributing one!

Property Descriptions

String address = "" 🔗

There is currently no description for this property. Please help us by contributing one!

int file_size = 0 🔗

  • void set_file_size(value: int)

  • int get_file_size()

There is currently no description for this property. Please help us by contributing one!

String filename = "" 🔗

There is currently no description for this property. Please help us by contributing one!

String local_path = "" 🔗

  • void set_local_path(value: String)

  • String get_local_path()

There is currently no description for this property. Please help us by contributing one!

int port = 0 🔗

  • void set_port(value: int)

  • int get_port()

There is currently no description for this property. Please help us by contributing one!

String remote_nick = "" 🔗

  • void set_remote_nick(value: String)

  • String get_remote_nick()

There is currently no description for this property. Please help us by contributing one!

Status status = 0 🔗

There is currently no description for this property. Please help us by contributing one!

int transferred = 0 🔗

  • int get_transferred()

There is currently no description for this property. Please help us by contributing one!

Type type = 0 🔗

  • void set_transfer_type(value: Type)

  • Type get_transfer_type()

There is currently no description for this property. Please help us by contributing one!

bool use_ipv6 = false 🔗

  • void set_use_ipv6(value: bool)

  • bool get_use_ipv6()

There is currently no description for this property. Please help us by contributing one!

Method Descriptions

Error accept() 🔗

Confirms an inbound request connection asynchronously by initializing an available receiver socket and commencing the binary byte stream buffer processing immediately.

Error cancel() 🔗

Aborts an active byte transmission connection natively, closing underlying stream peers and socket structures to prevent further buffer leaking.

String get_error_message() const 🔗

Returns the error message.

float get_progress() const 🔗

Returns the calculated progression of the byte payload transition over the active stream, expressed as a generalized percentage.

int get_resume_position() const 🔗

Returns the resume position.

Error reject() 🔗

Returns reject.

void set_resume_position(position: int) 🔗

Sets the resume position. position - Position.