class HTTP::WebSocketHandler
Overview
A handler which adds websocket functionality to an HTTP::Server
.
When a request can be upgraded, the associated HTTP::Websocket
and HTTP::Server::Context
will be yielded to the block. For example:
ws_handler = HTTP::WebSocketHandler.new do |ws, ctx|
ws.on_ping { ws.pong ctx.request.path }
end
server = HTTP::Server.new [ws_handler]
Included Modules
Defined in:
http/server/handlers/websocket_handler.cr Constructors
Instance Method Summary
Instance methods inherited from module HTTP::Handler
call(context : HTTP::Server::Context) call,
call_next(context : HTTP::Server::Context) call_next,
next : Handler | HandlerProc | Nil next,
next=(next __arg0 : Handler | HandlerProc | Nil) next= Instance methods inherited from class Reference
==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==,
dup dup,
hash(hasher) hash,
inspect(io : IO) : Nil inspect,
object_id : UInt64 object_id,
pretty_print(pp) : Nil pretty_print,
same?(other : Reference)
same?(other : Nil) same?,
to_s(io : IO) : Nil to_s Constructor methods inherited from class Reference
new new Instance methods inherited from class Object
! : Bool !,
!=(other) !=,
!~(other) !~,
==(other) ==,
===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===,
=~(other) =~,
as(type : Class) as,
as?(type : Class) as?,
class class,
dup dup,
hash(hasher)
hash hash,
in?(*values : Object) : Bool
in?(collection) : Bool in?,
inspect : String
inspect(io : IO) : Nil inspect,
is_a?(type : Class) : Bool is_a?,
itself itself,
nil? : Bool nil?,
not_nil! not_nil!,
pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect,
pretty_print(pp : PrettyPrint) : Nil pretty_print,
responds_to?(name : Symbol) : Bool responds_to?,
tap(&) tap,
to_json(io : IO)
to_json to_json,
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json(indent : String = " ") to_pretty_json,
to_s : String
to_s(io : IO) : Nil to_s,
to_yaml(io : IO)
to_yaml to_yaml,
try(&) try,
unsafe_as(type : T.class) forall T unsafe_as Class methods inherited from class Object
from_json(string_or_io, root : String)
from_json(string_or_io) from_json,
from_yaml(string_or_io : String | IO) from_yaml Constructor Detail
Instance Method Detail