Realm::network::websocket_observer Referência de estrutura

#include <websocket.hpp>

Funções de membro público
vazio virtual	websocket_connected_handler (const std::string &protocol)=0
vazio virtual	websocket_error_handler ()=0
bool virtual	websocket_binary_message_received (std::string_view data)=0
bool virtual	websocket_closed_handler (bool foi_clean, websocket_err_codes error_code, std::string_view message)=0

Descrição detalhada

Interface do observador do WebSocket no cliente de sincronização que recebe os eventos do websocket durante a operação.

Documentação da função do membro

websocket_binary_message_received()

virtual bool Realm::network::websocket_observer::websocket_binary_message_received ( std::string_view  de dados )

virtual puro

Chamado sempre que uma mensagem completa chega. A implementação do WebSocket é responsável por desfragmentar mensagens fragmentadas internamente e fornecer uma mensagem completa ao cliente de sincronização.

Parâmetros

de dados

Um util::Span contendo os dados recebidos do servidor. O buffer só é válido até que a função retorne.

Devoluções

bool designa se o objeto WebSocket deve continuar processando mensagens. O valor de retorno normal é true . False deve ser retornado se o objeto de websocket tiver sido destruído durante a execução da função.

websocket_closed_handler()

virtual bool Realm::network::websocket_observer::websocket_closed_handler ( bool  foi_clean, websocket_err_codes  error_code, std::string_view  mensagem  )

virtual puro

Chamado sempre que a conexão WebSocket for fechada, seja como resultado de um erro de WebSocket ou de um fechamento normal.

Parâmetros

foi_clean	A conexão TCP foi fechada após a conclusão da negociação de fechamento do WebSocket.
error_code	O código de erro recebido ou sincronizado quando o websocket foi fechado.
mensagem	A mensagem recebida no close framework quando o websocket foi fechado.

Devoluções

bool designa se o objeto WebSocket foi destruído durante a execução desta função. O valor de retorno normal é Verdadeiro para indicar que o objeto WebSocket não é mais válido. Se False for retornado, o objeto WebSocket será destruído em algum ponto no futuro.

websocket_connected_handler()

virtual vazio Realm::network::websocket_observer::websocket_connected_handler ( const std::string &  protocolo )

virtual puro

Chamado quando o WebSocket está conectado, ou seja, após a conclusão da negociação. O cliente de sincronização não tem permissão para enviar mensagens no soquete antes que a negociação seja concluída e nenhum retorno de chamada message_received será chamado antes que a negociação seja concluída.

Parâmetros

protocolo

O valor do subprotocolo negociação retornado pelo servidor

websocket_error_handler()

virtual vazio Realm::network::websocket_observer::websocket_error_handler ( )

virtual puro

Chamado quando ocorre um erro ao estabelecer a conexão do WebSocket com o servidor ou durante operações normais. Nenhuma mensagem binária adicional será processada após esta função ser chamada.

---

A documentação para esta estrutura foi gerada a partir do seguinte arquivo:

• include/cpprealm/network/websocket.hpp