plotly::detail Namespace Reference

Classes
class	HttpServer
class	JsonRpc
	JSON-RPC 2.0 server implementation over WebSocket. More...
struct	JsonRpcError
	Structure representing a JSON-RPC error object. More...
struct	JsonRpcResponse
	Structure representing a JSON-RPC response object. More...
class	WebsocketClient
class	WebsocketEndpointImpl
	Base implementation class for WebSocket endpoints. More...
class	WebsocketEndpointInterface
	Abstract interface for WebSocket endpoints. More...
class	WebsocketServer

Typedefs
using	client_config = websocketpp::config::asio_client
using	client_t = websocketpp::client<client_config>
using	connection_hdl = websocketpp::connection_hdl
using	server_config = websocketpp::config::asio
using	server_t = websocketpp::server<server_config>
using	endpoint_t = server_t

Enumerations
enum class	JsonRpcErrorCode : std::int16_t {   PARSE_ERROR = -32700 , INVALID_REQUEST = -32600 , METHOD_NOT_FOUND = -32601 , INVALID_PARAMS = -32602 ,   INTERNAL_ERROR = -32603 , SERVER_ERROR = -32000 }
	Enumeration of standard JSON-RPC 2.0 error codes. More...

Functions
auto	isDisplayAvailable () -> bool
auto	isChromiumAvailable () -> bool
auto	isGoogleChromeAvailable () -> bool
auto	openBrowser (const std::string_view url) -> bool
auto	openChromiumWithHeadlessMode (const std::string_view url, int remoteDebuggingPort) -> std::pair< bool, std::function< void()> >
auto	getIpv4Addresses () -> std::vector< std::string >
auto	setDownloadDirectory (const std::filesystem::path &directory, int remoteDebuggingPort) -> bool
auto	getDefaultDownloadDirectory () -> std::filesystem::path
auto	generateUUID () -> std::string

Typedef Documentation

client_config

using plotly::detail::client_config = websocketpp::config::asio_client

client_t

using plotly::detail::client_t = websocketpp::client<client_config>

connection_hdl

using plotly::detail::connection_hdl = websocketpp::connection_hdl

endpoint_t

using plotly::detail::endpoint_t = server_t

server_config

using plotly::detail::server_config = websocketpp::config::asio

server_t

using plotly::detail::server_t = websocketpp::server<server_config>

Enumeration Type Documentation

JsonRpcErrorCode

enum class plotly::detail::JsonRpcErrorCode : std::int16_t

strong

Enumeration of standard JSON-RPC 2.0 error codes.

Enumerator
PARSE_ERROR	Invalid JSON was received by the server.
INVALID_REQUEST	The JSON sent is not a valid Request object.
METHOD_NOT_FOUND	The method does not exist / is not available.
INVALID_PARAMS	Invalid method parameter(s)
INTERNAL_ERROR	Internal JSON-RPC error.
SERVER_ERROR	Server error.

Function Documentation

generateUUID()

auto plotly::detail::generateUUID

(

)

-> std::string

Generates a random UUID string in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Returns

A randomly generated UUID string

getDefaultDownloadDirectory()

auto plotly::detail::getDefaultDownloadDirectory

(

)

-> std::filesystem::path

getIpv4Addresses()

auto plotly::detail::getIpv4Addresses

(

)

-> std::vector< std::string >

isChromiumAvailable()

auto plotly::detail::isChromiumAvailable

(

)

-> bool

isDisplayAvailable()

auto plotly::detail::isDisplayAvailable

(

)

-> bool

isGoogleChromeAvailable()

auto plotly::detail::isGoogleChromeAvailable

(

)

-> bool

openBrowser()

auto plotly::detail::openBrowser

(

const std::string_view

url

)

-> bool

openChromiumWithHeadlessMode()

auto plotly::detail::openChromiumWithHeadlessMode	(	const std::string_view	url,
		int	remoteDebuggingPort ) -> std::pair< bool, std::function< void()> >

setDownloadDirectory()

auto plotly::detail::setDownloadDirectory	(	const std::filesystem::path &	directory,
		int	remoteDebuggingPort ) -> bool