This documentation is for development version 0.18.dev0.

mne.realtime.StimServer

class mne.realtime.StimServer(port=4218, n_clients=1)[source]

Stimulation Server.

Server to communicate with StimClient(s).

Parameters:
port : int

The port to which the stimulation server must bind to.

n_clients : int

The number of clients which will connect to the server.

See also

StimClient

Methods

__hash__($self, /) Return hash(self).
add_trigger(trigger[, verbose]) Add a trigger.
shutdown([verbose]) Shutdown the client and server.
start([timeout, verbose]) Start the server.
__hash__($self, /)

Return hash(self).

add_trigger(trigger, verbose=None)[source]

Add a trigger.

Parameters:
trigger : int

The trigger to be added to the queue for sending to StimClient.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). Defaults to self.verbose.

shutdown(verbose=None)[source]

Shutdown the client and server.

Parameters:
verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

start(timeout=inf, verbose=None)[source]

Start the server.

Parameters:
timeout : float

Maximum time to wait for clients to be added.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).