[][src]Function libeyelink_sys::eyelink_open

pub unsafe extern "C" fn eyelink_open() -> INT16

@ingroup init_eyelink Attempts to open a link connection to the EyeLink tracker. Simple connect to single Eyelink tracker. Equivalent to \c eyelink_open_node(broadcast_address, 0).

@remarks The tracker address can be set by calling the function \c set_eyelink_address(). If this address was "255.255.255.255" the call to \c eyelink_open() will "broadcast" a request to any tracker, however this may fail if multiple Ethernet cards are installed. For the broadcast option to work use EyeLink I v2.1 or higher, EyeLink II v1.1 or higher. Before using this command, call either \c open_eyelink_connection(-1) or \c open_eyelink_system () to prepare the link for use.

@return \c 0 if successful.\n \c LINK_INITIALIZE_FAILED if link could not be established.\n \c CONNECT_TIMEOUT_FAILED if tracker did not respond.\n \c WRONG_LINK_VERSION if the versions of the EyeLink library and tracker are incompatible.\n

\b Example:

\code

#include 

if(open_eyelink_connection(-1))
return -1;

set_eyelink_address("100.1.1.1");

if (eyelink_open())
return -1;
\endcode

\sa \c eyelink_broadcast_open(), \c eyelink_close(), \c eyelink_dummy_open(), \c eyelink_open_node(), \c open_eyelink_connection(), \c open_eyelink_system() and \c set_eyelink_address()