IS_ISI Struct Reference

InSim Init - packet to initialise the InSim system. More...

#include <ispackets.h>


Data Fields

byte Size
 44
byte Type
 ISP_ISI
byte ReqI
 If non-zero LFS will send an IS_VER packet.
byte Zero
 0
word UDPPort
 Port for UDP replies from LFS (0 to 65535).
word Flags
 Bit flags for options
byte Sp0
 0
byte Prefix
 Special host message prefix character.
word Interval
 Time in ms between NLP or MCI (0 = none).
char Admin [16]
 Admin password (if set in LFS).
char IName [16]
 A short name for your program.


Detailed Description

InSim Init - packet to initialise the InSim system.

Note 1)
UDPPort field when you connect using UDP :
  • zero : LFS sends all packets to the port of the incoming packet
  • non-zero : LFS sends all packets to the specified UDPPort
Note 2)
UDPPort field when you connect using TCP :
  • zero : LFS sends NLP / MCI packets using your TCP connection
  • non-zero : LFS sends NLP / MCI packets to the specified UDPPort
Note 3)
Flags field (set the relevant bits to turn on the option) :
In most cases you should not set both ISF_NLP and ISF_MCI flags because all IS_NLP information is included in the IS_MCI packet.
The ISF_LOCAL flag is important if your program creates buttons. It should be set if your program is not a host control system. If set, then buttons are created in the local button area, so avoiding conflict with the host buttons and allowing the user to switch them with SHIFT+B rather than SHIFT+I.
Note 4)
Prefix field, if set when initialising InSim on a host :
Messages typed with this prefix will be sent to your InSim program on the host (in IS_MSO) and not displayed on anyone's screen.

Definition at line 642 of file ispackets.h.


Field Documentation

44

Definition at line 644 of file ispackets.h.

ISP_ISI

Definition at line 645 of file ispackets.h.

If non-zero LFS will send an IS_VER packet.

Definition at line 646 of file ispackets.h.

0

Definition at line 647 of file ispackets.h.

Port for UDP replies from LFS (0 to 65535).

Definition at line 649 of file ispackets.h.

Bit flags for options

Definition at line 650 of file ispackets.h.

0

Definition at line 652 of file ispackets.h.

Special host message prefix character.

Definition at line 653 of file ispackets.h.

Time in ms between NLP or MCI (0 = none).

Definition at line 654 of file ispackets.h.

char IS_ISI::Admin[16]

Admin password (if set in LFS).

Definition at line 656 of file ispackets.h.

char IS_ISI::IName[16]

A short name for your program.

Definition at line 657 of file ispackets.h.


The documentation for this struct was generated from the following file:

Generated on Wed Apr 28 11:50:47 2010 for InSim by  doxygen 1.5.8