XU XUv0.13.1
EN

#net/websocket

导入方式: #net/websocket

公开 API: 5 函数, 6 方法, 2 类型, 10 常量, 0 方法集

标准库包 `#net/websocket`。

const OP_CONTINUATION

XuAPI
pub const OP_CONTINUATION = 0

用途

常量 OP_CONTINUATION,定义了相关的协议或算法配置参数。

const OP_TEXT

XuAPI
pub const OP_TEXT = 1

用途

常量 OP_TEXT,定义了相关的协议或算法配置参数。

const OP_BINARY

XuAPI
pub const OP_BINARY = 2

用途

常量 OP_BINARY,定义了相关的协议或算法配置参数。

const OP_CLOSE

XuAPI
pub const OP_CLOSE = 8

用途

常量 OP_CLOSE,定义了相关的协议或算法配置参数。

const OP_PING

XuAPI
pub const OP_PING = 9

用途

常量 OP_PING,定义了相关的协议或算法配置参数。

const OP_PONG

XuAPI
pub const OP_PONG = 10

用途

常量 OP_PONG,定义了相关的协议或算法配置参数。

const STATUS_NORMAL

XuAPI
pub const STATUS_NORMAL = 1000

用途

常量 STATUS_NORMAL,定义了相关的协议或算法配置参数。

const STATUS_GOING_AWAY

XuAPI
pub const STATUS_GOING_AWAY = 1001

用途

常量 STATUS_GOING_AWAY,定义了相关的协议或算法配置参数。

const STATUS_PROTOCOL_ERROR

XuAPI
pub const STATUS_PROTOCOL_ERROR = 1002

用途

常量 STATUS_PROTOCOL_ERROR,定义了相关的协议或算法配置参数。

const STATUS_UNSUPPORTED

XuAPI
pub const STATUS_UNSUPPORTED = 1003

用途

常量 STATUS_UNSUPPORTED,定义了相关的协议或算法配置参数。

compute_accept_key

XuAPI
pub fn compute_accept_key(challenge_key string) string

用途

执行 compute accept key 操作。

参数

challenge_key string
challenge_key(string)

返回值

string — 结果字符串

struct Frame

XuAPI
pub struct Frame {
    pub fin bool
    pub opcode int
    pub masked bool
    pub payload string
}

用途

Websocket 协议数据帧结构封装。

公开字段

fin bool
字段(bool)
opcode int
字段(int)
masked bool
字段(bool)
payload string
字段(string)

encode_frame

XuAPI
pub fn encode_frame(fin bool, opcode int, payload &string, mask bool) string

用途

编码 frame 数据。

参数

fin bool
fin(bool)
opcode int
opcode(int)
payload &string
payload(只读借用,调用方仍持有原值;类型 &string)
mask bool
mask(bool)

返回值

string — 结果字符串

decode_frame

XuAPI
pub fn decode_frame(raw &string) Frame

用途

解码 frame 数据。失败时抛出错误,调用方需处理或继续传播。

参数

raw &string
raw(只读借用,调用方仍持有原值;类型 &string)

返回值

Frame — 该类型的值

struct Conn

XuAPI
pub struct Conn {
    pub fd int
    pub is_client bool
    pub closed bool
}

用途

承载 fd、is_client、closed 等属性的结构体。

公开字段

fd int
文件描述符
is_client bool
字段(bool)
closed bool
字段(bool)

new_conn

XuAPI
pub fn new_conn(fd int, is_client bool) Conn

用途

构造 conn。

参数

fd int
文件描述符(int)
is_client bool
is_client(bool)

返回值

Conn — 该类型的值

($&Conn) write_message

XuAPI
pub fn (c $&Conn) write_message(opcode int, payload string) int

用途

$&Conn 上的操作:执行 write message 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Conn
本次调用使用的 Conn 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
opcode int
opcode(int)
payload string
payload(string)

返回值

int — 该类型的值

($&Conn) write_text

XuAPI
pub fn (c $&Conn) write_text(text string) int

用途

$&Conn 上的操作:写入文本。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Conn
本次调用使用的 Conn 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
text string
文本(string)

返回值

int — 该类型的值

($&Conn) write_binary

XuAPI
pub fn (c $&Conn) write_binary(data string) int

用途

$&Conn 上的操作:执行 write binary 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Conn
本次调用使用的 Conn 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
data string
数据(string)

返回值

int — 该类型的值

($&Conn) write_ping

XuAPI
pub fn (c $&Conn) write_ping(data string) int

用途

$&Conn 上的操作:执行 write ping 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Conn
本次调用使用的 Conn 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
data string
数据(string)

返回值

int — 该类型的值

($&Conn) write_pong

XuAPI
pub fn (c $&Conn) write_pong(data string) int

用途

$&Conn 上的操作:执行 write pong 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Conn
本次调用使用的 Conn 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
data string
数据(string)

返回值

int — 该类型的值

($&Conn) close

XuAPI
pub fn (c $&Conn) close(code int, reason string) int

用途

$&Conn 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Conn
本次调用使用的 Conn 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
code int
码(int)
reason string
reason(string)

返回值

int — 该类型的值

upgrade

XuAPI
pub fn upgrade(ctx http.Context) Conn

用途

执行 upgrade 处理。失败时抛出错误,调用方需处理或继续传播。

参数

ctx http.Context
ctx(http.Context)

返回值

Conn — 该类型的值