#include <fbserv.h>

Collaboration diagram for fbserv_obj:

Data Fields
struct fb *	fbs_fbp
	framebuffer pointer

void *	fbs_interp
	interpreter

struct fbserv_listener	fbs_listener
	data for listening

struct fbserv_client	fbs_clients [MAX_CLIENTS]
	connected clients

int(*	fbs_is_listening )(struct fbserv_obj *)
	return 1 if listening, else 0

int(*	fbs_listen_on_port )(struct fbserv_obj *, int)
	return 1 on success, 0 on failure

void(*	fbs_open_server_handler )(struct fbserv_obj *)
	platform/toolkit method to open listener handler

void(*	fbs_close_server_handler )(struct fbserv_obj *)
	platform/toolkit method to close handler listener

void(*	fbs_open_client_handler )(struct fbserv_obj , int, void )
	platform/toolkit specific client handler setup (called by fbs_new_client)

void(*	fbs_close_client_handler )(struct fbserv_obj *, int)
	platform/toolkit method to close handler for client at index client_id

void(*	fbs_open_ipc_client_handler )(struct fbserv_obj , int, void )
	Optional IPC-specific client open handler.

void(*	fbs_close_ipc_client_handler )(struct fbserv_obj *, int)
	Optional IPC-specific client close handler (mirrors fbs_close_client_handler).

void(*	fbs_callback )(void *)
	callback function

void *	fbs_clientData

struct bu_vls *	msgs

int	fbs_mode
	0-off, 1-underlay, 2-interlay, 3-overlay

char	fbs_auth_token [65]
	session token (64 hex chars + NUL); empty = no auth required

int	fbs_require_auth
	!0 = reject clients that don't send MSG_FBAUTH

void *	fbs_tls_ctx
	opaque SSL_CTX* for TLS; NULL = no TLS

Detailed Description

Definition at line 89 of file fbserv.h.

Field Documentation

◆ fbs_fbp

struct fb* fbs_fbp

framebuffer pointer

Definition at line 90 of file fbserv.h.

◆ fbs_interp

void* fbs_interp

interpreter

Definition at line 91 of file fbserv.h.

◆ fbs_listener

struct fbserv_listener fbs_listener

data for listening

Definition at line 92 of file fbserv.h.

◆ fbs_clients

struct fbserv_client fbs_clients[MAX_CLIENTS]

connected clients

Definition at line 93 of file fbserv.h.

◆ fbs_is_listening

int(* fbs_is_listening) (struct fbserv_obj *)

return 1 if listening, else 0

Definition at line 95 of file fbserv.h.

◆ fbs_listen_on_port

int(* fbs_listen_on_port) (struct fbserv_obj *, int)

return 1 on success, 0 on failure

Definition at line 96 of file fbserv.h.

◆ fbs_open_server_handler

void(* fbs_open_server_handler) (struct fbserv_obj *)

platform/toolkit method to open listener handler

Definition at line 97 of file fbserv.h.

◆ fbs_close_server_handler

void(* fbs_close_server_handler) (struct fbserv_obj *)

platform/toolkit method to close handler listener

Definition at line 98 of file fbserv.h.

◆ fbs_open_client_handler

void(* fbs_open_client_handler) (struct fbserv_obj *, int, void *)

platform/toolkit specific client handler setup (called by fbs_new_client)

Definition at line 99 of file fbserv.h.

◆ fbs_close_client_handler

void(* fbs_close_client_handler) (struct fbserv_obj *, int)

platform/toolkit method to close handler for client at index client_id

Definition at line 100 of file fbserv.h.

◆ fbs_open_ipc_client_handler

void(* fbs_open_ipc_client_handler) (struct fbserv_obj *, int, void *)

Optional IPC-specific client open handler.

When non-NULL, called by fbs_open_ipc() instead of fbs_open_client_handler for clients whose connection was established via IPC (pipe/socketpair). The toolkit-specific TCP client setup (e.g. QTcpSocket connections) is not appropriate for IPC clients; this handler installs fd-based I/O monitoring instead (e.g. Tcl_CreateFileHandler, QSocketNotifier).

May be NULL, in which case fbs_open_client_handler is used (callers must ensure that handler tolerates NULL data).

Definition at line 113 of file fbserv.h.

◆ fbs_close_ipc_client_handler

void(* fbs_close_ipc_client_handler) (struct fbserv_obj *, int)

Optional IPC-specific client close handler (mirrors fbs_close_client_handler).

When non-NULL, called by drop_client() for IPC clients (fbsc_is_ipc != 0). May be NULL, in which case fbs_close_client_handler is used.

Definition at line 120 of file fbserv.h.

◆ fbs_callback

void(* fbs_callback) (void *)

callback function

Definition at line 122 of file fbserv.h.

◆ fbs_clientData

void* fbs_clientData

Definition at line 123 of file fbserv.h.

◆ msgs

struct bu_vls* msgs

Definition at line 124 of file fbserv.h.

◆ fbs_mode

int fbs_mode

0-off, 1-underlay, 2-interlay, 3-overlay

Definition at line 125 of file fbserv.h.

◆ fbs_auth_token

char fbs_auth_token[65]

session token (64 hex chars + NUL); empty = no auth required

Definition at line 127 of file fbserv.h.

◆ fbs_require_auth

int fbs_require_auth

!0 = reject clients that don't send MSG_FBAUTH

Definition at line 128 of file fbserv.h.

◆ fbs_tls_ctx

void* fbs_tls_ctx

opaque SSL_CTX* for TLS; NULL = no TLS

Definition at line 129 of file fbserv.h.

The documentation for this struct was generated from the following file:

include/dm/fbserv.h

Data Fields