Welcome Guest, you are in: Login

EventIDE Wiki



Search the wiki


TCP Port Element

Modified on 2018/07/16 21:57 by Administrator Categorized as Communications


Element Icon TCP Port
Category: Communication AddIn: Base Elements
Creator: OkazoLab Scope: Parent event
Owns Snippets: None Usage: Snippets


NameDescription                              ConstraintsTypeOn
Port Number        Defines the TCP Port number for input listening                Int32         
IP Address        Defines an server IP address for input listening                String         
No-delay Mode        Defines whether the Nagle's algorithm is disabled on the TCP port, such that it sends the output data without a buffering delay.                Boolean         
Working Mode        Defines a working mode for the element. Select 'Auto Output' mode for sending data synchronously with an onset of the parent event, 'Input Detection' mode for catching the particular pattern in port input and 'Manual Output'/'Input Listener' modes for custom writing/reading scenarios controlled via snippets.                stSeri..         
Encoding        The encoding method that is used to convert raw port bytes into text strings and vice verse. The default encoding is ByteChar which converts each byte of data to a single char.                stSeri..         
Buffer Size        Size of the input circular buffer (in bytes) that stores all incoming port data when the element works in the 'Input Listener' mode. If the buffer is small, a part of the data can be lost before it is read by the program                Int32         
Test Input        Start a dialog window that monitors arriving port input in realtime. Use for verification of the selected port settings and encoding method.                Boolean         
Input        Returns a string containing the most recent port input, when the element works in the input modes. The property value is refreshed on each Control Loop step, therefore, it should be read in the Control Loop snippet.                String         
Triggering Input        When the element works in the 'Input Detection' mode, a value of this property defines the 'catching' input string. If such string is detected an incoming input at some moment, the element registers the detection time and becomes triggered. This property is essential for time-accurate registration of the specific input, e.g a button press, coming out of a external device.                String         
Trigger Once        Defines whether the element can be triggered multiple times, while the parent event is active. If the property value is 'true', only the first triggering is registered. Triggering can occur only in the 'Triggering on specific input' working mode                Boolean         
Runtime Status
Is Triggered        Indicates whether the element has been triggered at least once, since activation of the parent event. Triggering can occur only in the 'Input Detection' working mode.                Boolean         
Triggering Time        Returns a local event time of the last triggering on the element. Triggering can occur only in the 'Triggering on specific input' working mode.                clTime         
Is Enabled        If set to false the element is completely omitted when the experiment is run                Boolean         
Title        Title of the element                String         

TCP Port Element allows listening input communications via the TCP network ports. The element currently does not support sending data via a TCP port, please don't use it in the output modes, as other port elements!




Snapshot 1

Snapshot 1

Snapshot 2

Snapshot 2

Practical Use


Technique 1

  1. Step 1
  2. Step 2
    === Technique 2 ===
  3. Step 1
  4. Step 2

     // Check the trial outcome. Result and RT just other user variables
    // insert code snippet here..
    == Notes ==
  5. Insert Notes here..
  6. Insert Notes here..
  Name Size
- TCP-Port-Element-Icon.png 3.17 KB

ScrewTurn Wiki version Some of the icons created by FamFamFam.