server::websocket::WebSocketConnection Class Reference

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

• Detailed Description
• Public Member Functions
• Protected Member Functions
• Member Function Documentation
• Recv()
• Send()
• SendBinary()
• TryRecv()

#include <userver/server/websocket/server.hpp>

Detailed Description

Main class for Websocket connection.

Examples

samples/websocket_service/main.cpp.

Definition at line 63 of file server.hpp.

Public Member Functions
	WebSocketConnection (WebSocketConnection &&)=delete
	WebSocketConnection (const WebSocketConnection &)=delete
WebSocketConnection &	operator= (WebSocketConnection &&)=delete
WebSocketConnection &	operator= (const WebSocketConnection &)=delete
virtual void	Recv (Message &message)=0
	Read a message from websocket, handling pings under the hood.
virtual bool	TryRecv (Message &message)=0
	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.
virtual void	Send (const Message &message)=0
	Send a message to websocket.
virtual void	SendText (std::string_view message)=0
template<typename ContiguousContainer>
void	SendBinary (const ContiguousContainer &message)
virtual void	Close (CloseStatus status_code)=0
virtual const engine::io::Sockaddr &	RemoteAddr () const =0
virtual void	AddFinalTags (tracing::Span &span) const =0
virtual void	AddStatistics (Statistics &stats) const =0

Protected Member Functions
virtual void	DoSendBinary (utils::span< const std::byte > message)=0

Member Function Documentation

Recv()

virtual void server::websocket::WebSocketConnection::Recv ( Message & message )

pure virtual

Read a message from websocket, handling pings under the hood.

Parameters

message

input message

Exceptions

engine::io::IoException

in case of socket errors

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 instead.

Examples

samples/websocket_service/main.cpp.

Send()

virtual void server::websocket::WebSocketConnection::Send ( const Message & message )

pure virtual

Send a message to websocket.

Parameters

message

message to send

Exceptions

engine::io::IoException

in case of socket errors

Note

Send() is not thread-safe by itself (you may not call Send() 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 instead.

Examples

samples/websocket_service/main.cpp.

SendBinary()

template<typename ContiguousContainer>

void server::websocket::WebSocketConnection::SendBinary ( const ContiguousContainer & message )

inline

Definition at line 99 of file server.hpp.

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:

• userver/server/websocket/server.hpp