PonyTCP¶

[Source]

primitive val PonyTCP

Constructors¶

create¶

[Source]

new val create()
: PonyTCP val^

Returns¶

PonyTCP val^

Public Functions¶

listen¶

[Source]

fun box listen(
  the_actor: AsioEventNotify tag,
  host: String val,
  port: String val,
  ip_version: (IP4 val | IP6 val | DualStack val) = reference)
: Pointer[AsioEvent val] tag

Parameters¶

the_actor: AsioEventNotify tag
host: String val
port: String val
ip_version: (IP4 val | IP6 val | DualStack val) = reference

Returns¶

Pointer[AsioEvent val] tag

accept¶

[Source]

fun box accept(
  event: Pointer[AsioEvent val] tag)
: I32 val

Parameters¶

event: Pointer[AsioEvent val] tag

Returns¶

I32 val

close¶

[Source]

fun box close(
  fd: U32 val)
: None val

Parameters¶

fd: U32 val

Returns¶

None val

connect¶

[Source]

fun box connect(
  the_actor: AsioEventNotify tag,
  host: String val,
  port: String val,
  from: String val,
  asio_flags: U32 val,
  ip_version: (IP4 val | IP6 val | DualStack val) = reference)
: U32 val

Parameters¶

the_actor: AsioEventNotify tag
host: String val
port: String val
from: String val
asio_flags: U32 val
ip_version: (IP4 val | IP6 val | DualStack val) = reference

Returns¶

U32 val

keepalive¶

[Source]

fun box keepalive(
  fd: U32 val,
  secs: U32 val)
: None val

Parameters¶

fd: U32 val
secs: U32 val

Returns¶

None val

peername¶

[Source]

fun box peername(
  fd: U32 val,
  ip: NetAddress tag)
: Bool val

Parameters¶

fd: U32 val
ip: NetAddress tag

Returns¶

Bool val

receive¶

[Source]

fun box receive(
  event: Pointer[AsioEvent val] tag,
  buffer: Pointer[U8 val] tag,
  offset: USize val)
: USize val ?

Parameters¶

event: Pointer[AsioEvent val] tag
buffer: Pointer[U8 val] tag
offset: USize val

Returns¶

USize val ?

send¶

[Source]

fun box send(
  event: Pointer[AsioEvent val] tag,
  buffer: (String val | Array[U8 val] val),
  from_offset: USize val = 0)
: USize val ?

Parameters¶

event: Pointer[AsioEvent val] tag
buffer: (String val | Array[U8 val] val)
from_offset: USize val = 0

Returns¶

USize val ?

shutdown¶

[Source]

fun box shutdown(
  fd: U32 val)
: None val

Parameters¶

fd: U32 val

Returns¶

None val

sockname¶

[Source]

fun box sockname(
  fd: U32 val,
  ip: NetAddress tag)
: Bool val

Parameters¶

fd: U32 val
ip: NetAddress tag

Returns¶

Bool val

writev¶

[Source]

Send count buffers from data starting at index from via writev. Builds the platform-specific IOV array (iovec on POSIX, WSABUF on Windows) internally.

first_buffer_byte_offset skips bytes in data(from) for partial write resume.

Returns bytes sent (POSIX) or buffer count submitted (Windows).

fun box writev(
  event: Pointer[AsioEvent val] tag,
  data: Array[(String val | Array[U8 val] val)] box,
  from: USize val,
  count: USize val,
  first_buffer_byte_offset: USize val = 0)
: USize val ?

Parameters¶

event: Pointer[AsioEvent val] tag
data: Array[(String val | Array[U8 val] val)] box
from: USize val
count: USize val
first_buffer_byte_offset: USize val = 0

Returns¶

USize val ?

writev_max¶

[Source]

Maximum number of IOV entries per writev call. IOV_MAX on POSIX, 1 on Windows (Windows submits all entries at once, not in batches).

fun box writev_max()
: I32 val

Returns¶

I32 val

eq¶

[Source]

fun box eq(
  that: PonyTCP val)
: Bool val

Parameters¶

that: PonyTCP val

Returns¶

Bool val

ne¶

[Source]

fun box ne(
  that: PonyTCP val)
: Bool val

Parameters¶

that: PonyTCP val

Returns¶

Bool val