NetworkWebSocketConnectionInterface Class Reference

#include <network_websocket.h>

Inheritance diagram for NetworkWebSocketConnectionInterface:

详细描述

Class that handles the WebSocket Protocol and an easy interface to use WebSockets.

Public Types

using  RESTRICT_DICTIONARY_PROPS = NETWORKWEBSOCKETCONNECTIONPROPERTIES::RESTRICT

公共成员函数

MAXON_METHOD Result < void >  Init (const NetworkHttpHandlerRef &handler)
const MAXON_METHOD NetworkHttpHandlerRef &  GetHandler () const
MAXON_METHOD Result < void >  关闭 ()
MAXON_METHOD Result < void >  Send (const Block < const Char > &buffer, WEBSOCKETTYPE type)
MAXON_METHOD Result < void >  Send (const String &data, WEBSOCKETTYPE type= WEBSOCKETTYPE::TEXT )
MAXON_METHOD WEBSOCKETSTATE   GetState () const

私有成员函数

  MAXON_INTERFACE ( NetworkWebSocketConnectionInterface , MAXON_REFERENCE_NORMAL , "net.maxon.interface.networkwebsocketconnection")

Member Typedef Documentation

◆  RESTRICT_DICTIONARY_PROPS

using RESTRICT_DICTIONARY_PROPS = NETWORKWEBSOCKETCONNECTIONPROPERTIES::RESTRICT

成员函数文档编制

◆  MAXON_INTERFACE()

MAXON_INTERFACE ( NetworkWebSocketConnectionInterface   ,
MAXON_REFERENCE_NORMAL   ,
"net.maxon.interface.networkwebsocketconnection"   
)
private

◆  Init()

MAXON_METHOD Result <void> Init ( const NetworkHttpHandlerRef &  handler )

◆  GetHandler()

const MAXON_METHOD NetworkHttpHandlerRef& GetHandler ( ) const

◆  Close()

MAXON_METHOD Result <void> Close ( )

Closes the WebSocket connection.

返回
OK on success.

◆  Send() [1/2]

MAXON_METHOD Result <void> Send ( const Block < const Char > &  buffer ,
WEBSOCKETTYPE   type  
)

Send bytes as WebProtocol message.

参数
[in] buffer Buffer data to send.
[in] type Defines the type of the WebSocket frame to be send.
返回
OK on success.

◆  Send() [2/2]

MAXON_METHOD Result <void> Send ( const String data ,
WEBSOCKETTYPE   type = WEBSOCKETTYPE::TEXT  
)

Send String as WebProtocol message.

参数
[in] data 数据 to be send.
[in] type Type of the data to be send (see WEBSOCKETTYPE).
返回
OK on success.

◆  GetState()

MAXON_METHOD WEBSOCKETSTATE GetState ( ) const

Returns the state of the connection.

返回
Returns the state of the connection.