Technical Reference:SignalSharingClient Library - Revision history

Mellinger: /* SSC_RESULT SSC_DeleteConnector(SSC_HANDLE) */

2026-03-12T16:18:39Z

SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)

← Older revision		Revision as of 16:18, 12 March 2026
Line 15:		Line 15:
	===SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)===		===SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)===
	Stop listening, terminate the internal server thread, and delete the given connector object. Must be called when connector object is no longer used.		Stop listening, terminate the internal server thread, and delete the given connector object. Must be called when connector object is no longer used.

			Providing a nullptr handle to <tt>SSC_DeleteConnector()</tt> will result in an <tt>SSC_INVALID_ARG</tt> error but will otherwise cause no harm.

	===SSC_RESULT SSC_RegisterSignalCallback(SSC_HANDLE, SSC_CALLBACK, void* refdata)===		===SSC_RESULT SSC_RegisterSignalCallback(SSC_HANDLE, SSC_CALLBACK, void* refdata)===

Mellinger: /* SSC_RESULT SSC_CreateConnector(const char* listeningAddress, SSC_HANDLE) /

2026-03-12T16:17:08Z

SSC_RESULT SSC_CreateConnector(const char* listeningAddress, SSC_HANDLE*)

← Older revision		Revision as of 16:17, 12 March 2026
Line 9:		Line 9:
	<tt>SSC_CreateConnector()</tt> will immediately start an internal server thread, and listen at the given port.		<tt>SSC_CreateConnector()</tt> will immediately start an internal server thread, and listen at the given port.
	Only one client can connect to the server at a time (note that BCI2000 acts as a client).		Only one client can connect to the server at a time (note that BCI2000 acts as a client).

			<tt>SSC_CreateConnector()</tt> guarantees that the handle it returns will be either a valid handle, or nullptr (if an error occurs).
			This implies that <tt>SSC_DeleteConnector()</tt> may be called unconditionally on a handle returned by <tt>SSC_CreateConnector()</tt>.

	===SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)===		===SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)===

Mellinger: /* See also */

2026-03-12T15:36:09Z

Mellinger: /* SSC_RESULT SSC_LockStates(SSC_HANDLE, const double** pStateData, int* count, int* samples, const char* const** pStateNames) */

2026-03-12T15:21:35Z

SSC_RESULT SSC_LockStates(SSC_HANDLE, const double** pStateData, int* count, int* samples, const char* const** pStateNames)

← Older revision		Revision as of 15:21, 12 March 2026
Line 45:		Line 45:
	===SSC_RESULT SSC_LockStates(SSC_HANDLE, const double** pStateData, int* count, int* samples, const char* const** pStateNames)===		===SSC_RESULT SSC_LockStates(SSC_HANDLE, const double** pStateData, int* count, int* samples, const char* const** pStateNames)===
	Lock state data and obtain state information. Typically, this function will be called from a state callback.		Lock state data and obtain state information. Typically, this function will be called from a state callback.
	Locking blocks the arrival of new state data, so call <tt>SCC_ReleaseStates)</tt> as soon as possible.		Locking blocks the arrival of new state data, so call <tt>SCC_ReleaseStates()</tt> as soon as possible.
	All pointer arguments are optional, may be <tt>nullptr</tt>.		All pointer arguments are optional, may be <tt>nullptr</tt>.

Mellinger: /* Functions provided by the Library */

2026-03-12T15:21:10Z

Functions provided by the Library

← Older revision		Revision as of 15:21, 12 March 2026
Line 7:		Line 7:
	and is specified as the first argument of the remaining ''SignalSharingClient'' library functions.		and is specified as the first argument of the remaining ''SignalSharingClient'' library functions.
	The listening address is in the format <IP>:<port> with <IP> being a name or numeric address.		The listening address is in the format <IP>:<port> with <IP> being a name or numeric address.
			<tt>SSC_CreateConnector()</tt> will immediately start an internal server thread, and listen at the given port.
			Only one client can connect to the server at a time (note that BCI2000 acts as a client).

	===SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)===		===SSC_RESULT SSC_DeleteConnector(SSC_HANDLE)===
	~~Delete a~~ connector object. Must be called when connector object is no longer used.		Stop listening, terminate the internal server thread, and delete the given connector object. Must be called when connector object is no longer used.

	===SSC_RESULT SSC_RegisterSignalCallback(SSC_HANDLE, SSC_CALLBACK, void* refdata)===		===SSC_RESULT SSC_RegisterSignalCallback(SSC_HANDLE, SSC_CALLBACK, void* refdata)===

Mellinger: /* Error Codes */

2026-03-11T16:48:16Z

Error Codes

← Older revision		Revision as of 16:48, 11 March 2026
Line 85:		Line 85:
	\| SSC_INVALID_ARG \|\| One or more of the function's arguments were invalid.		\| SSC_INVALID_ARG \|\| One or more of the function's arguments were invalid.
	\|-		\|-
	\| SSC_CANNOT_LISTEN \|\| The connector was created but could not ~~attach~~ to the given address.		\| SSC_CANNOT_LISTEN \|\| The connector was created but could not bind to/listen on the given address.
	\|-		\|-
	\| SSC_CANNOT_FULFILL_REQUEST \|\| The connector is in a state in which it cannot fulfill the request, try again later.		\| SSC_CANNOT_FULFILL_REQUEST \|\| The connector is in a state in which it cannot fulfill the request, try again later.

Mellinger: /* SSC_RESULT SSC_LockStates(SSC_HANDLE, const double**, int* count, int* samples, const char* const** pStateNames) */

2026-03-11T15:05:31Z

SSC_RESULT SSC_LockStates(SSC_HANDLE, const double**, int* count, int* samples, const char* const** pStateNames)

← Older revision		Revision as of 15:05, 11 March 2026
Line 41:		Line 41:
	Releases a locked signal. Call this function as soon as you are done with forwarding or processing signal data.		Releases a locked signal. Call this function as soon as you are done with forwarding or processing signal data.

	===SSC_RESULT SSC_LockStates(SSC_HANDLE, const double*, int count, int* samples, const char* const** pStateNames)===		===SSC_RESULT SSC_LockStates(SSC_HANDLE, const double** pStateData, int* count, int* samples, const char* const** pStateNames)===
	Lock state data and obtain state information. Typically, this function will be called from a state callback.		Lock state data and obtain state information. Typically, this function will be called from a state callback.
	Locking blocks the arrival of new state data, so call <tt>SCC_ReleaseStates)</tt> as soon as possible.		Locking blocks the arrival of new state data, so call <tt>SCC_ReleaseStates)</tt> as soon as possible.
	All pointer arguments are optional, may be <tt>nullptr</tt>.		All pointer arguments are optional, may be <tt>nullptr</tt>.

			The ''pStateData'' argument receives a pointer to an array in channel-major format, i.e. use the following formula to compute a linear index from state and sample index:
			idx = state * samples + sample

	===SSC_RESULT SSC_ReleaseStates(SSC_HANDLE)===		===SSC_RESULT SSC_ReleaseStates(SSC_HANDLE)===

Mellinger: /* SSC_RESULT SSC_LockSignal(SSC_HANDLE, const double** pSignal, int* channels, int* samples, const char* const** channelNames) */

2026-03-11T15:02:41Z

SSC_RESULT SSC_LockSignal(SSC_HANDLE, const double** pSignal, int* channels, int* samples, const char* const** channelNames)

← Older revision		Revision as of 15:02, 11 March 2026
Line 33:		Line 33:
	Locking blocks the arrival of new signal data, so call <tt>SCC_ReleaseSignal()</tt> as soon as possible.		Locking blocks the arrival of new signal data, so call <tt>SCC_ReleaseSignal()</tt> as soon as possible.
	All pointer arguments are optional, may be <tt>nullptr</tt>.		All pointer arguments are optional, may be <tt>nullptr</tt>.

			The ''pSignal'' argument receives a pointer to an array in channel-major order, i.e. to compute a linear index into that array from both
			channel and sample index, use
			idx = channel * samples + sample

	===SSC_RESULT SSC_ReleaseSignal(SSC_HANDLE)===		===SSC_RESULT SSC_ReleaseSignal(SSC_HANDLE)===

Mellinger: /* Callback Function Type */

2026-03-11T14:45:19Z

Callback Function Type

@@ Line 69: / Line 69: @@
   void MyCallback(void* refdata)
 The ''refdata'' argument will hold the struct or object pointer specified as ''refdata'' when calling <tt>SSC_Register*Callback()</tt>.
 ==See also==

Mellinger: /* Functions provided by the Library */

2026-03-11T14:35:31Z

Functions provided by the Library

← Older revision		Revision as of 14:35, 11 March 2026
Line 64:		Line 64:
	===SSC_RESULT SSC_Commit(SSC_HANDLE)===		===SSC_RESULT SSC_Commit(SSC_HANDLE)===
	Commit pushed signal and state data to the BCI2000 pipeline. Any previously pushed signal or state data will be inserted into the BCI2000 pipeline when this function is called.		Commit pushed signal and state data to the BCI2000 pipeline. Any previously pushed signal or state data will be inserted into the BCI2000 pipeline when this function is called.

			==Callback Function Type==
			To be registered using <tt>SSC_Register*Callback()</tt>, a function must be a free (non-member) or static function, and have the following signature:
			void MyCallback(void* refdata)
			The ''refdata'' argument will hold the struct or object pointer specified as ''refdata'' when calling <tt>SSC_Register*Callback()</tt>.

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

← Older revision		Revision as of 15:36, 12 March 2026
Line 93:		Line 93:

	==See also==		==See also==
			[[Programming Reference:SignalSharingClientLibDemo]],
	[[Technical Reference:BCI2000Remote Library]], [[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PresentationLink]], <!--[[Contributions:BCI2000Automation]],-->		[[Technical Reference:BCI2000Remote Library]], [[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PresentationLink]], <!--[[Contributions:BCI2000Automation]],-->
	[[Contributions:Applications]]		[[Contributions:Applications]]

	[[Category:External Interfaces]][[Category:User Application]]		[[Category:External Interfaces]][[Category:User Application]]

Technical Reference:SignalSharingClient Library - Revision history

Mellinger: /* SSC_RESULT SSC_DeleteConnector(SSC_HANDLE) */

Mellinger: /* SSC_RESULT SSC_CreateConnector(const char* listeningAddress, SSC_HANDLE*) */

Mellinger: /* See also */

Mellinger: /* SSC_RESULT SSC_LockStates(SSC_HANDLE, const double** pStateData, int* count, int* samples, const char* const** pStateNames) */

Mellinger: /* Functions provided by the Library */

Mellinger: /* Error Codes */

Mellinger: /* SSC_RESULT SSC_LockStates(SSC_HANDLE, const double**, int* count, int* samples, const char* const** pStateNames) */

Mellinger: /* SSC_RESULT SSC_LockSignal(SSC_HANDLE, const double** pSignal, int* channels, int* samples, const char* const** channelNames) */

Mellinger: /* Callback Function Type */

Mellinger: /* Functions provided by the Library */

Mellinger: /* SSC_RESULT SSC_CreateConnector(const char* listeningAddress, SSC_HANDLE) /