Synchronet v3.17b-Win32 (install) has been released (Jan-2019).

New Synchronet YouTube channel

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
service:index [2010/03/07 21:41]
digitalman
service:index [2018/03/04 23:02] (current)
deuce [Standard Services] "Standard" implies on by default.
Line 1: Line 1:
 ====== Services ====== ====== Services ======
  
-Synchronet Services((a feature suggested by Angus McLeod)) are loadable modules or external executables designed to be loaded by the Synchronet //Services Server// to service a particular TCP or UDP protocol for remote client connections. Synchronet Services are similar in concept to UNIX's [x]inetd services.+Synchronet Services((a feature suggested by Angus McLeod ​of ANJO BBS)) are loadable modules or external executables designed to be loaded by the Synchronet //Services Server// to service a particular TCP or UDP protocol for remote client connections. Synchronet Services are similar in concept to UNIX's [x]inetd services.
  
 ===== Service Types ===== ===== Service Types =====
  
-There four types of services supported:+There are four types of services ​currently ​supported:
  
   - Dynamic JavaScript (the most common service type)   - Dynamic JavaScript (the most common service type)
Line 11: Line 11:
   - Dynamic Native   - Dynamic Native
   - Static Native   - Static Native
 +
 +===== JavaScript Services =====
 +Additional methods and properties available to Synchronet Services written in JavaScript:
 +
 +==== Properties ====
 +
 +^Property ​ ^Type     ​^Description^
 +|''​logged_in''​ |boolean|Indication if user has successfully authenticated or not|
 +|''​datagram'' ​ |string |Contents of received UDP datagram (when applicable)|
 +
 +==== Methods ====
 +
 +Along with the [[http://​synchro.net/​docs/​jsobjs.html#​global_methods|common global methods]], JavaScript services include support for the following methods:
 +
 +^Method ​  ​^Returns ^Usage ^Description^
 +|''​login''​|boolean|''​login(user,​ password [,​increment_logins=//​false//​])''​|Attempt to authenticate as specified user (name or number)|
 +|''​logout''​|boolean|''​logout()'' ​                                         |Logout currently authenticated user|
 +|''​server.client_add''​|void|''​server.client_add(//​Socket//,​ [user], [host])'' ​   |Register client based on specified socket connection, with optional username and hostname|
 +|''​server.client_update''​|void|''​server.client_update(//​Socket//,​ [user], [host])''​|Update client based on specified socket connection, with optional username and hostname|
 +|''​server.client_remove''​|void|''​server.client_remove(//​Socket//​)'' ​   |Unregister client based on specified socket connection|
  
 ===== Configuration ===== ===== Configuration =====
  
-Services are normally configured ​in the ''​[[:​config:​services.ini]]''​ file in the ''​[[dir:​ctrl]]''​ directory.+Services are normally configured ​via the ''​[[:​config:​services.ini]]''​ file in the ''​[[dir:​ctrl]]''​ directory ​with some global settings controlled via the ''​[Services]''​ section of the ''​[[:​config:​sbbs.ini]]''​ file.
  
 Some static services (e.g. the [[:​service:​ircd|IRC Daemon]]) may alternatively be executed independently of the //Services Server// using [[:​util:​JSexec]]. Some static services (e.g. the [[:​service:​ircd|IRC Daemon]]) may alternatively be executed independently of the //Services Server// using [[:​util:​JSexec]].
  
-===== Standard ​Services =====+===== Included ​Services =====
  
 {{indexmenu>​.}} {{indexmenu>​.}}
Line 25: Line 45:
   * [[:​config:​services.ini]]   * [[:​config:​services.ini]]
   * [[:​server:​|Servers]]   * [[:​server:​|Servers]]
 +
 +{{tag>​tcpip servers services javascript}}
  

In Other Languages