Simpact Freeway 1150 User's Guide

Simpact, Inc.9210 Sky Park CourtSan Diego, CA 92123 Freeway ® Client-ServerInterface Control Document DC 900-1303C December 1999

10 DC 900-1303C Freeway Client-Server Interface Control Document Document Conventions This document follows the most significant byte first (MSB) and m

Preface DC 900-1303C 11 The term “Freeway” refers to any of the Freeway server models (for example, Freeway1100/1150/1200/1300, Freeway 2000/4000, or

12 DC 900-1303C Freeway Client-Server Interface Control Document

DC 900-1303C 13Chapter1OverviewThis document describes Simpact’s client/server interface to the Freeway communica-tions server. It’s primary purpose

14 DC 900-1303CFreeway Client-Server Interface Control DocumentThe TSI and DLI provide a consistent, high-level, common interface across multiplehosts

1: OverviewDC 900-1303C 15Figure 1–1: Typical Freeway ConfigurationVxWorksSNMPServerManagementServerResidentApplicationsMessageMultiplexorTelnetrloginL

16 DC 900-1303CFreeway Client-Server Interface Control DocumentFreeway can be configured with multiple WAN interface processor boards, which areSimpact

1: OverviewDC 900-1303C 171.2 Freeway Client-Server EnvironmentFreeway acts as a gateway that connects a client on a local-area network to a wide-area

18 DC 900-1303CFreeway Client-Server Interface Control DocumentFigure 1–2: Freeway Configuration with Clients That Do Not Use the DLI3138ApplicationTSI

1: OverviewDC 900-1303C 19NoteMessage formats and protocols used between the Freeway serverand its client applications are subject to change in future

Simpact, Inc.9210 Sky Park CourtSan Diego, CA 92123(858) 565-1865 Freeway Client-Server Interface Control Document© 1994 through 1999 Simpact, Inc. A

20 DC 900-1303CFreeway Client-Server Interface Control Document1.2.2 Establishing a Freeway ConnectionAfter the TSI configuration is defined, the client

DC 900-1303C 21Chapter2Freeway Client-Server ProtocolThe Freeway client and server communicate via TCP/IP BSD-style sockets. (The server-resident clie

22 DC 900-1303CFreeway Client-Server Interface Control Documentdescription of the well-known port parameter, see the “Customizing System Installa-tion

2: Freeway Client-Server ProtocolDC 900-1303C 23of TSI data packets can begin immediately. Figure 2–1 on page 25 shows an example ofthis type of data

24 DC 900-1303CFreeway Client-Server Interface Control DocumentEcho requestNot implemented at this time.Echo replyNot implemented at this time.ACKThe

2: Freeway Client-Server ProtocolDC 900-1303C 25Figure 2–1: TSI Connection Data Flow (Without Arbitration)Figure 2–2: TSI Connection Data Flow (With A

26 DC 900-1303CFreeway Client-Server Interface Control Document2.1.2 TSI Data PacketsA TSI data packet is a communication between a client and a serve

2: Freeway Client-Server ProtocolDC 900-1303C 27Open SessionThis is the first TSI data packet that a client should send for a new Freeway session. This

28 DC 900-1303CFreeway Client-Server Interface Control DocumentGet TimeNot implemented at this time.Get VersionThis packet requests the Freeway softwa

2: Freeway Client-Server ProtocolDC 900-1303C 29Expedite Data Packet to ICPThis packet is identical to the Data Packet to ICP, except it requests an e

DC 900-1303C 3 Contents List of Figures 5Preface 71 Overview 13 1.1 Freeway Overview... 141.2 Freeway Client-Server Enviro

30 DC 900-1303CFreeway Client-Server Interface Control Document2.2 Example Client-Server Exchange (without Client TSI)Figure 2–4 shows an example clie

2: Freeway Client-Server ProtocolDC 900-1303C 312.3 Freeway Packet Header FormatsSeveral headers precede ICP data in packets exchanged between the cli

32 DC 900-1303CFreeway Client-Server Interface Control Document2.3.1 TSI Header FormatThe TSI header precedes all data sent over the BSD socket. If th

2: Freeway Client-Server ProtocolDC 900-1303C 33Packet Type (2 bytes)This field indicates the type of packet. There are two distinct types of packetsun

34 DC 900-1303CFreeway Client-Server Interface Control DocumentEcho request (4)Not implemented at this time.Echo reply (5)Not implemented at this time

2: Freeway Client-Server ProtocolDC 900-1303C 352.3.2 Freeway Header FormatThe Freeway header immediately follows the TSI header. All TSI Data packets

36 DC 900-1303CFreeway Client-Server Interface Control DocumentType (2 bytes)This field is equivalent to the usFWType field in the DLI_OPT_ARGS structur

2: Freeway Client-Server ProtocolDC 900-1303C 37Data packet from ICP (3)Status (2 bytes)This field is equivalent to the usFWStatus field in the DLI_OPT_

38 DC 900-1303CFreeway Client-Server Interface Control DocumentNo session is available (3)The Freeway server is out of session entries to manage a new

2: Freeway Client-Server ProtocolDC 900-1303C 39No more nodes are available (11)The server could not assign a node to the ICP on an Open Session reque

4 DC 900-1303C Freeway Client-Server Interface Control Document 3.1.1 Bind Request Packet... 453.1.2 Unbind Request Packet ..

40 DC 900-1303CFreeway Client-Server Interface Control Document2.3.3 ICP Header FormatThe ICP header immediately follows the Freeway header for all pa

2: Freeway Client-Server ProtocolDC 900-1303C 41Command (2 bytes)This field is equivalent to the usICPCommand field in the DLI_OPT_ARGS structure.For va

42 DC 900-1303CFreeway Client-Server Interface Control Document2.3.4 Protocol Header FormatThe Protocol header immediately follows the ICP header for

2: Freeway Client-Server ProtocolDC 900-1303C 43Circuit ID (2 bytes)This field is equivalent to the usProtCircuitID field in the DLI_OPT_ARGS structure

44 DC 900-1303CFreeway Client-Server Interface Control Document

DC 900-1303C 45Chapter3Packet FormatsThis chapter presents the format of each packet exchanged between the client applica-tion and the Freeway server.

46 DC 900-1303CFreeway Client-Server Interface Control DocumentThe data fields in the Bind request packet are as follows:Max Packet Length (2 bytes)Thi

3: Packet FormatsDC 900-1303C 473.1.2 Unbind Request PacketThe unbind request consists of a TSI header. Client applications should use this only ifthe

48 DC 900-1303CFreeway Client-Server Interface Control Document3.1.4 ACK PacketThe ACK response consists of a TSI header. Client applications should u

3: Packet FormatsDC 900-1303C 493.2 Freeway Control Packet FormatsEach Freeway control packet contains a TSI header and a Freeway header. Optionally,

DC 900-1303C 5 List of Figures Figure 1–1: Typical Freeway Configuration ... 15Figure 1–2: Freeway Configuration with Clients That

50 DC 900-1303CFreeway Client-Server Interface Control Document3.2.2 Open Session Response PacketThe Open Session response consists of a TSI header an

3: Packet FormatsDC 900-1303C 513.2.3 Close Session Request PacketThe Close Session request consists of a TSI header and a Freeway header. a sequenc

52 DC 900-1303CFreeway Client-Server Interface Control Document3.2.4 Close Session Response PacketThe Close Session response consists of a TSI header

3: Packet FormatsDC 900-1303C 533.2.5 Get Version Request PacketThe Get Version request consists of a TSI header and a Freeway header. a sequence nu

54 DC 900-1303CFreeway Client-Server Interface Control Document3.2.6 Get Version Response PacketThe Get Version response consists of a TSI header and

3: Packet FormatsDC 900-1303C 553.3 ICP Protocol Packet FormatEach ICP Protocol packet contains a TSI header, a Freeway header, an ICP header, anda Pr

56 DC 900-1303CFreeway Client-Server Interface Control Document a The ICP header is 16 bytes; a generic headeris shown here. Refer to the appropr

DC 900-1303C 57IndexAACK 24, 34ACK data 24, 34ACK packet 48Audience, intended 7BBind 22, 33Bind request packet 45Bit numbering 10BSD socket 17, 20, 21

58 DC 900-1303CFreeway Client-Server Interface Control DocumentExchanging data with Freeway 20Expedite data packet to ICP 29Expedite write to ICP requ

IndexDC 900-1303C 59Parameter 3 41Private header size 35Product support 11Protocol header format 42Protocol packet formatICP 55Protocol, client-server

6 DC 900-1303C Freeway Client-Server Interface Control Document

60 DC 900-1303CFreeway Client-Server Interface Control Document

Freeway Client-Server InterfaceControl DocumentDC 900-1303CCustomer Report FormWe are constantly improving our products. If you have suggestions or pr

Simpact, Inc.Customer Service9210 Sky Park CourtSan Diego, CA 92123

DC 900-1303C 7 Preface Purpose of Document This document describes the packets that are exchanged between a client and a Freewayserver. It aids the c

8 DC 900-1303C Freeway Client-Server Interface Control Document Required Equipment A Freeway 1100/1150/1200/1300, Freeway 2000/4000, or Freeway 8800

Preface DC 900-1303C 9 • Freeway 2000/4000 Hardware Installation Guide DC-900-1331 • Freeway 8800 Hardware Installation Guide DC-900-1553 • Freeway I