pianod2
multisource multiuser scriptable networked music player
Public Attributes | List of all members
fb_service_options_t Struct Reference

Service options are passed to a new service, defining its behavior. More...

#include <fb_public.h>

Collaboration diagram for fb_service_options_t:
Collaboration graph
[legend]

Public Attributes

int line_port
 Line-oriented port, or 0 to disable. More...
 
int http_port
 HTTP (or combo depending on service mode) port, or 0 to disable. More...
 
int https_port
 HTTP Secure port, or combo, or 0 to disable. More...
 
int queue_size
 Listen queue size before connections are rejected. More...
 
size_t context_size
 Size of user context allocated for new connections. More...
 
char * greeting
 Default HELO. More...
 
char * name
 Name of service, for URL processing and hosts_access lookups. More...
 
char * serve_directory
 Location of files to be served by HTTP. More...
 
char * locale_directory
 Subdirectory with internationalization files for HTTP. More...
 
time_t websocket_ping_interval
 
FB_I18N_MODE internationalization
 How often to send a ping on websocket; 0 = never. More...
 
FB_GREETING_MODE greeting_mode
 Whether to accept/require greeting. More...
 
bool transfer_only
 
struct fb_service_tparent
 Service will accept transfers; no ports required. More...
 

Detailed Description

Service options are passed to a new service, defining its behavior.

Member Data Documentation

◆ context_size

size_t fb_service_options_t::context_size

Size of user context allocated for new connections.

◆ greeting

char* fb_service_options_t::greeting

Default HELO.

◆ greeting_mode

FB_GREETING_MODE fb_service_options_t::greeting_mode

Whether to accept/require greeting.

See FB_GREETING_MODE

◆ http_port

int fb_service_options_t::http_port

HTTP (or combo depending on service mode) port, or 0 to disable.

◆ https_port

int fb_service_options_t::https_port

HTTP Secure port, or combo, or 0 to disable.

◆ internationalization

FB_I18N_MODE fb_service_options_t::internationalization

How often to send a ping on websocket; 0 = never.

Mode for locating localized files for HTTP

◆ line_port

int fb_service_options_t::line_port

Line-oriented port, or 0 to disable.

◆ locale_directory

char* fb_service_options_t::locale_directory

Subdirectory with internationalization files for HTTP.

◆ name

char* fb_service_options_t::name

Name of service, for URL processing and hosts_access lookups.

◆ parent

struct fb_service_t* fb_service_options_t::parent

Service will accept transfers; no ports required.

◆ queue_size

int fb_service_options_t::queue_size

Listen queue size before connections are rejected.

◆ serve_directory

char* fb_service_options_t::serve_directory

Location of files to be served by HTTP.

◆ transfer_only

bool fb_service_options_t::transfer_only

◆ websocket_ping_interval

time_t fb_service_options_t::websocket_ping_interval

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