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: IPVersion = reference)
: AsioEventID

Parameters¶

the_actor: AsioEventNotify tag
host: String val
port: String val
ip_version: IPVersion = reference

Returns¶

AsioEventID

accept¶

[Source]

fun box accept(
  event: AsioEventID)
: I32 val

Parameters¶

event: AsioEventID

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: IPVersion = reference)
: U32 val

Parameters¶

the_actor: AsioEventNotify tag
host: String val
port: String val
from: String val
asio_flags: U32 val
ip_version: IPVersion = 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 ref)
: Bool val

Parameters¶

fd: U32 val
ip: NetAddress ref

Returns¶

Bool val

receive¶

[Source]

Receive up to size bytes into buffer. Returns the tri-state socket result plus the number of bytes received on SocketResultOk. On Windows IOCP, SocketResultOk always returns a count of 0 — the actual byte count arrives asynchronously via the read-completion callback.

fun box receive(
  event: AsioEventID,
  buffer: Pointer[U8 val] tag,
  size: USize val)
: (SocketResult , USize val)

Parameters¶

event: AsioEventID
buffer: Pointer[U8 val] tag
size: USize val

Returns¶

(SocketResult , USize val)

send¶

[Source]

Send bytes from buffer starting at from_offset. Returns the tri-state socket result plus the number of bytes accepted by the OS (POSIX) or queued for IOCP (Windows) on SocketResultOk.

fun box send(
  event: AsioEventID,
  buffer: ByteSeq,
  from_offset: USize val = 0)
: (SocketResult , USize val)

Parameters¶

event: AsioEventID
buffer: ByteSeq
from_offset: USize val = 0

Returns¶

(SocketResult , 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 ref)
: Bool val

Parameters¶

fd: U32 val
ip: NetAddress ref

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 the tri-state socket result plus a count: bytes sent on POSIX, buffer count submitted on Windows.

fun box writev(
  event: AsioEventID,
  data: Array[ByteSeq] box,
  from: USize val,
  count: USize val,
  first_buffer_byte_offset: USize val = 0)
: (SocketResult , USize val) ?

Parameters¶

event: AsioEventID
data: Array[ByteSeq] box
from: USize val
count: USize val
first_buffer_byte_offset: USize val = 0

Returns¶

(SocketResult , 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