gun:ws_send(3)

Name

gun:ws_send - Send Websocket frames

Description

ws_send(ConnPid, Frames) -> ok

ConnPid :: pid()
Frames  :: Frame | [Frame]
Frame   :: close | ping | pong
         | {text | binary | close | ping | pong, iodata()}
         | {close, non_neg_integer(), iodata()}

Send Websocket frames.

The connection must first be upgraded to Websocket using the function gun:ws_upgrade(3).

Arguments

ConnPid

The pid of the Gun connection process.

Frames

A Websocket frame.

Return value

The atom ok is returned.

Changelog

  • 1.0: Function introduced.

Examples

Send a single frame
gun:ws_send(ConnPid, {text, <<"Hello world!">>}).

See also

gun(3), gun:ws_upgrade(3), gun_upgrade(3), gun_ws(3)

Gun 1.3 Function Reference

Navigation

Version select

Like my work? Donate!

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.