Technical Reference:Operator Library - Revision history

Mellinger: /* Callback Constants */

2025-08-18T14:24:39Z

Callback Constants

← Older revision		Revision as of 14:24, 18 August 2025
Line 181:		Line 181:
	;BCI_Handled		;BCI_Handled
	:Return this constant to indicate that your callback handled the event. Only used with callback functions listed with an "int" return type.		:Return this constant to indicate that your callback handled the event. Only used with callback functions listed with an "int" return type.
	~~;BCI_HandledWithError~~
	~~:Return this constant to indicate that your callback handled the event but an error occurred. Only used with the BCI_OnUnknownCommand() callback function.~~
	;BCI_NotHandled		;BCI_NotHandled
	:Return this constant to indicate that your callback did not handle the event in question. Only used with callback functions listed with an "int" return type.		:Return this constant to indicate that your callback did not handle the event in question. Only used with callback functions listed with an "int" return type.

Mellinger: /* const char* BCI_AllocateString( const char* ) */

2025-08-18T14:20:23Z

const char* BCI_AllocateString( const char* )

@@ Line 374: / Line 374: @@
 ;arguments: Pointer to a null-terminated string.
 ;returns:   Pointer to a null-terminated copy of the argument string. The result is allocated by the library and should be released using <tt>BCI_ReleaseObject()</tt>.
 ==See also==

Mellinger: /* const char* BCI_AllocateString( const char* ) */

2025-08-18T14:13:45Z

const char* BCI_AllocateString( const char* )

← Older revision		Revision as of 14:13, 18 August 2025
Line 373:		Line 373:
	Allocate a copy of the given string on the Operator Library's heap.		Allocate a copy of the given string on the Operator Library's heap.
	;arguments: Pointer to a null-terminated string.		;arguments: Pointer to a null-terminated string.
	;returns: Pointer to a null-terminated copy of the argument string.		;returns: Pointer to a null-terminated copy of the argument string. The result is allocated by the library and should be released using <tt>BCI_ReleaseObject()</tt>.
	The result is allocated by the library and should be released
	using <tt>BCI_ReleaseObject()</tt>.

	==See also==		==See also==

Mellinger: /* int BCI_ReleaseObject( const char* ) */

2025-08-18T14:13:10Z

int BCI_ReleaseObject( const char* )

← Older revision		Revision as of 14:13, 18 August 2025
Line 369:		Line 369:
	;arguments: Object to be released, or NULL.		;arguments: Object to be released, or NULL.
	;returns: 1 if successful, 0 otherwise.		;returns: 1 if successful, 0 otherwise.

			===const char* BCI_AllocateString( const char* )===
			Allocate a copy of the given string on the Operator Library's heap.
			;arguments: Pointer to a null-terminated string.
			;returns: Pointer to a null-terminated copy of the argument string.
			The result is allocated by the library and should be released
			using <tt>BCI_ReleaseObject()</tt>.

	==See also==		==See also==

Mellinger: /* int BCI_OnUnknownCommand( void* refdata, const char* command ) */

2025-08-18T14:09:59Z

int BCI_OnUnknownCommand( void* refdata, const char* command )

← Older revision		Revision as of 14:09, 18 August 2025
Line 239:		Line 239:
	When addressing pixels, the pair of indices <tt>(x,y)</tt> corresponds to the single index <tt>y*width+x</tt>. Note that this is different from the layout of signal messages.		When addressing pixels, the pair of indices <tt>(x,y)</tt> corresponds to the single index <tt>y*width+x</tt>. Note that this is different from the layout of signal messages.

	===int BCI_OnUnknownCommand( void* refdata, const char* command )===		===int BCI_OnUnknownCommand( void* refdata, const char* command, const char output, const char error )===
	Triggered when the [[User Reference:Operator Module Scripting\|Operator Module Scripting]] engine meets an unknown command. The event handler can be used to extend the set of commands by handling those commands that are unknown to the scripting engine. To report that a command has been handled, return <tt>BCI_Handled~~</tt> or <tt>BCI_HandledWithError~~</tt> from the callback function. Otherwise, return a value of <tt>BCI_NotHandled</tt>.		Triggered when the [[User Reference:Operator Module Scripting\|Operator Module Scripting]] engine meets an unknown command. The event handler can be used to extend the set of commands by handling those commands that are unknown to the scripting engine. To report that a command has been handled, return <tt>BCI_Handled</tt> from the callback function. Otherwise, return a value of <tt>BCI_NotHandled</tt>.

			If your command produces any output, use <tt>BCI_AllocateString()</tt> to allocate a string, and assign the resulting <tt>const char</tt> to <tt>output</tt>.

			If your command produces any error messages, use <tt>BCI_AllocateString()</tt> to allocate a string, and assign the resulting <tt>const char</tt> to <tt>error</tt>.

	===BCI_OnScriptHelp( void* refdata, const char** pMsg )===		===BCI_OnScriptHelp( void* refdata, const char** pMsg )===

Mellinger: /* int BCI_WebsocketClose( void ) */

2024-05-01T13:51:58Z

int BCI_WebsocketClose( void )

← Older revision		Revision as of 13:51, 1 May 2024
Line 344:		Line 344:

	=== int BCI_WebsocketClose( void )===		=== int BCI_WebsocketClose( void )===
	Stop all WebSocket servers, ~~closing any~~ open connections.		Stop all WebSocket servers, while keeping open connections.
	;returns: 1 if no error occurred, 0 otherwise.		;returns: 1 if no error occurred, 0 otherwise.

Mellinger: /* int BCI_WebsocketStop( const char* address ) */

2024-05-01T13:51:27Z

int BCI_WebsocketStop( const char* address )

← Older revision		Revision as of 13:51, 1 May 2024
Line 337:		Line 337:
	;returns: 1 if no error occurred, 0 otherwise.		;returns: 1 if no error occurred, 0 otherwise.

	=== int ~~BCI_WebsocketStop~~( const char* address )===		=== int BCI_WebsocketCloseOne( const char* address )===
	Stop the websocket server that is listening at the given address.		Stop the websocket server that is listening at the given address.
	If no websocket server is listening ~~ath~~ the given address, 0 is returned.		If no websocket server is listening at the given address, 0 is returned.
	;arguments: Address as a string in <IP>:<port> format.		;arguments: Address as a string in <IP>:<port> format.
	;returns: 1 if a websocket server was listening at the given address, 0 otherwise.		;returns: 1 if a websocket server was listening at the given address, 0 otherwise.

Mellinger: /* int BCI_TelnetClose( void ) */

2024-05-01T13:51:03Z

int BCI_TelnetClose( void )

← Older revision		Revision as of 13:51, 1 May 2024
Line 327:		Line 327:

	=== int BCI_TelnetClose( void )===		=== int BCI_TelnetClose( void )===
	Stop all telnet servers, ~~closing any~~ open connections.		Stop all telnet servers, while keeping open connections.
	;returns: 1 if no error occurred, 0 otherwise.		;returns: 1 if no error occurred, 0 otherwise.

Mellinger: /* int BCI_TelnetStop( const char* address ) */

2024-05-01T13:50:44Z

int BCI_TelnetStop( const char* address )

← Older revision		Revision as of 13:50, 1 May 2024
Line 320:		Line 320:
	;returns: 1 if no error occurred, 0 otherwise.		;returns: 1 if no error occurred, 0 otherwise.

	=== int ~~BCI_TelnetStop~~( const char* address )===		=== int BCI_TelnetCloseOne( const char* address )===
	Stop the telnet server that is listening at the given address.		Stop the telnet server that is listening at the given address.
	If no telnet server is listening ~~ath~~ the given address, 0 is returned.		If no telnet server is listening at the given address, 0 is returned.
	;arguments: Address as a string in <IP>:<port> format.		;arguments: Address as a string in <IP>:<port> format.
	;returns: 1 if a telnet server was listening at the given address, 0 otherwise.		;returns: 1 if a telnet server was listening at the given address, 0 otherwise.

Mellinger: /* int BCI_TelnetListen( const char* address ) */

2024-04-29T19:43:45Z

int BCI_TelnetListen( const char* address )

← Older revision		Revision as of 19:43, 29 April 2024
Line 315:		Line 315:
	=== int BCI_TelnetListen( const char* address )===		=== int BCI_TelnetListen( const char* address )===
	Start a telnet server, listening at the given address. By opening a telnet connection, it is possible to execute [[User_Reference:Operator_Module_Scripting\|scripting commands]] interactively.		Start a telnet server, listening at the given address. By opening a telnet connection, it is possible to execute [[User_Reference:Operator_Module_Scripting\|scripting commands]] interactively.
	Any number of telnet servers may be started ~~for~~ different addresses. If a telnet server is already running for a given		Any number of telnet servers may be started listening on different addresses. If a telnet server is already running for a given
	address, the request will be ignored, and 0 will be returned.		address, the request will be ignored, and 0 will be returned.
	;arguments: Address as a string in <IP>:<port> format. May be NULL, in which case it defaults to "localhost:3999".		;arguments: Address as a string in <IP>:<port> format. May be NULL, in which case it defaults to "localhost:3999".