#include <userver/server/websocket/server.hpp>
Main class for Websocket connection.
- Examples
- samples/websocket_service/main.cpp.
Definition at line 63 of file server.hpp.
|
virtual void | DoSendBinary (utils::span< const std::byte > message)=0 |
|
◆ Recv()
virtual void server::websocket::WebSocketConnection::Recv |
( |
Message & | message | ) |
|
|
pure virtual |
Read a message from websocket, handling pings under the hood.
- Parameters
-
- Exceptions
-
- Note
- Recv() is not thread-safe by itself (you may not call Recv() from multiple coroutines at once). It is not safe to call Recv() and Send() from different coroutines at once if TLS is used. Consider using Send()+TryRecv() from the same coroutine instaead.
- Examples
- samples/websocket_service/main.cpp.
◆ Send()
virtual void server::websocket::WebSocketConnection::Send |
( |
const Message & | message | ) |
|
|
pure virtual |
◆ SendBinary()
template<typename ContiguousContainer>
void server::websocket::WebSocketConnection::SendBinary |
( |
const ContiguousContainer & | message | ) |
|
|
inline |
◆ TryRecv()
virtual bool server::websocket::WebSocketConnection::TryRecv |
( |
Message & | message | ) |
|
|
pure virtual |
Behaves in the same way as Recv(), but in case of first bytes of message are not yet ready to receive gives the control up to a client.
- Returns
- false in case of messages absence, otherwise true and behaves like Recv()
The documentation for this class was generated from the following file: