1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/httpuv.R
\docType{class}
\name{WebSocket-class}
\alias{WebSocket-class}
\alias{WebSocket}
\title{WebSocket object}
\arguments{
\item{...}{For internal use only.}
}
\description{
An object that represents a single WebSocket connection. The object can be
used to send messages and close the connection, and to receive notifications
when messages are received or the connection is closed.
}
\details{
WebSocket objects should never be created directly. They are obtained by
passing an \code{onWSOpen} function to \code{\link{startServer}}.
}
\section{Fields}{
\describe{
\item{\code{request}}{
The Rook request environment that opened the connection. This can be
used to inspect HTTP headers, for example.
}
}
}
\section{Methods}{
\describe{
\item{\code{onMessage(func)}}{
Registers a callback function that will be invoked whenever a message
is received on this connection. The callback function will be invoked
with two arguments. The first argument is \code{TRUE} if the message
is binary and \code{FALSE} if it is text. The second argument is either
a raw vector (if the message is binary) or a character vector.
}
\item{\code{onClose(func)}}{
Registers a callback function that will be invoked when the connection
is closed.
}
\item{\code{send(message)}}{
Begins sending the given message over the websocket. The message must
be either a raw vector, or a single-element character vector that is
encoded in UTF-8.
}
\item{\code{close()}}{
Closes the websocket connection.
}
}
}
|
