TCN TRDP2 D BOM 033 Xx TRDP Reference Manual

TCN-TRDP2-D-BOM-033-xx%20-%20TRDP%20Reference%20Manual

User Manual:

Open the PDF directly: View PDF .
Page Count: 406 [warning: Documents this large are best viewed by clicking the View PDF Link!]

1 The TRDP Light Library API Specification
2 Data Structure Index
- 2.1 Data Structures
3 File Index
- 3.1 File List
4 Data Structure Documentation
5 File Documentation
Index

TCNOpen TRDP Light

ReleaseV1.4

Generated by Doxygen 1.8.13

Contents

1 The TRDP Light Library API Speciﬁcation 1

1.1 General Information .......................................... 1

1.1.1 Purpose ............................................ 1

1.1.2 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.1.3 Related documents ...................................... 1

1.1.4 Abbreviations and Deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2 Terminology .............................................. 2

1.3 Conventions of the API ........................................ 3

2 Data Structure Index 5

2.1 Data Structures ............................................ 5

3 File Index 7

3.1 File List ................................................ 7

4 Data Structure Documentation 9

4.1 DNS_HEADER Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.2 GNU_PACKED Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4.2.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.2.2.1 confVehCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.2.2.2 confVehList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.2.2.3 cstList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.2.2.4 cstUUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

ii CONTENTS

4.2.2.5 datasetLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.2.2.6 deviceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.2.2.7 etbId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.2.2.8 etbTopoCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.2.2.9 inhibit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2.2.10 isLead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2.2.11 leadDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2.2.12 leadVehOfCst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2.2.13 lifesign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2.2.14 msgType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2.2.15 opCstList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.2.2.16 opTrnDirState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.2.2.17 opTrnTopoCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.2.2.18 opVehList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.2.2.19 ownOpCstNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.2.2.20 protocolVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.2.2.21 reserved01 [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.2.2.22 reserved01 [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.2.2.23 reserved02 [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.2.2.24 reserved02 [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.2.2.25 reserved03 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.2.2.26 reserved04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.2.2.27 reserved06 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.2.2.28 safetyTrail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.2.2.29 trnCstNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.2.2.30 trnDirState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.2.2.31 trnId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.2.2.32 trnNetDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.2.2.33 trnOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.2.2.34 trnTopoCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Generated by Doxygen

CONTENTS iii

4.2.2.35 trnVehNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.2.2.36 vehId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.2.2.37 vehOrient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.2.2.38 version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.3 PD_ELE Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

4.3.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

4.3.2.1 pFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

4.4 TAU_MARSHALL_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

4.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4.5 TCN_URI Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4.6 TRDP_CLTR_CST_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.7 TRDP_COMID_DSID_MAP_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.8 TRDP_CONSIST_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.8.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.8.2.1 cstId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.8.2.2 cstOwner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.9 TRDP_DATASET Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

4.10 TRDP_DATASET_ELEMENT_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 29

4.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.11 TRDP_DBG_CONFIG_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.12 TRDP_DNS_REPLY Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.12.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Generated by Doxygen

iv CONTENTS

4.12.2.1 tcnUriCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4.13 TRDP_DNS_REQUEST Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.13.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.13.2.1 tcnUriCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.14 TRDP_ETB_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.14.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.14.2.1 cnCnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.15 TRDP_FUNCTION_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.15.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.15.2.1 cnId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.15.2.2 cstVehNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.15.2.3 etbId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.15.2.4 fctId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.16 TRDP_HANDLE Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.17 TRDP_LIST_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4.18 TRDP_MARSHALL_CONFIG_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4.19 TRDP_MD_CONFIG_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

4.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4.20 TRDP_MD_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4.21 TRDP_MD_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.22 TRDP_MEM_CONFIG_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Generated by Doxygen

CONTENTS v

4.23 TRDP_MEM_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.24 TRDP_PD_CONFIG_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

4.25 TRDP_PD_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

4.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4.26 TRDP_PD_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4.27 TRDP_PROCESS_CONFIG_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4.28 TRDP_PROP_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.29 TRDP_PUB_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.29.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.29.2.1 destAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.30 TRDP_RED_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.31 TRDP_SDT_PAR_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4.32 TRDP_SEND_PARAM_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4.33 TRDP_SEQ_CNT_ENTRY_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4.34 TRDP_SESSION Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

4.35 TRDP_SOCKET_TCP Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4.36 TRDP_SOCKETS Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Generated by Doxygen

vi CONTENTS

4.36.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.36.2.1 usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.37 TRDP_STATISTICS_REQUEST_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 52

4.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

4.38 TRDP_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

4.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.39 TRDP_SUBS_STATISTICS_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.39.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.39.2.1 ﬁlterAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.39.2.2 timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.39.2.3 toBehav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.40 TRDP_VEHICLE_INFO_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.40.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.40.2.1 vehId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.41 TRDP_XML_DOC_HANDLE_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.42 VOS_SOCK_OPT_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.43 VOS_VERSION_T Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Generated by Doxygen

CONTENTS vii

5 File Documentation 59

5.1 iec61375-2-3.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

5.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

5.1.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.1.2.1 ETB_CTRL_COMID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.1.2.2 TRDP_ETBCTRL_DSID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.1.2.3 TRDP_MAX_FILE_NAME_LEN . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.1.2.4 TRDP_MAX_LABEL_LEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.1.2.5 TRDP_MAX_MD_DATA_SIZE . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.1.2.6 TRDP_MAX_URI_HOST_LEN . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.1.2.7 TRDP_MAX_URI_LEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.1.2.8 TRDP_MAX_URI_USER_LEN . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.1.2.9 TRDP_MD_DEFAULT_REPLY_TIMEOUT . . . . . . . . . . . . . . . . . . . . 65

5.1.2.10 TRDP_MD_INFINITE_TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.1.2.11 TRDP_MIN_PD_HEADER_SIZE . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.1.2.12 TRDP_MSG_PD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.1.2.13 TRDP_PD_UDP_PORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.1.2.14 TRDP_PROCESS_DEFAULT_CYCLE_TIME . . . . . . . . . . . . . . . . . . . 66

5.1.2.15 TRDP_USR_URI_SIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.1.2.16 TTDB_NET_DIR_REQ_COMID . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.1.2.17 TTDB_OP_DIR_INFO_COMID . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.1.2.18 TTDB_STAT_CST_REQ_COMID . . . . . . . . . . . . . . . . . . . . . . . . . 67

5.1.2.19 TTDB_TRN_DIR_REQ_COMID . . . . . . . . . . . . . . . . . . . . . . . . . . 67

5.2 tau_cstinfo.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

5.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.2.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.2.2.1 cstInfoGetPropSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.3 tau_ctrl.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

5.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

5.3.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Generated by Doxygen

viii CONTENTS

5.3.2.1 tau_getEcspStat() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

5.3.2.2 tau_initEcspCtrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

5.3.2.3 tau_requestEcspConﬁrm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

5.3.2.4 tau_setEcspCtrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

5.3.2.5 tau_terminateEcspCtrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

5.4 tau_ctrl.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

5.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

5.4.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

5.4.2.1 tau_getEcspStat() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

5.4.2.2 tau_initEcspCtrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

5.4.2.3 tau_requestEcspConﬁrm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

5.4.2.4 tau_setEcspCtrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

5.4.2.5 tau_terminateEcspCtrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

5.5 tau_ctrl_types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

5.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

5.6 tau_dnr.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

5.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

5.6.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

5.6.2.1 tau_addr2Uri() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

5.6.2.2 tau_deInitDnr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

5.6.2.3 tau_DNRstatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

5.6.2.4 tau_getOwnAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

5.6.2.5 tau_initDnr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

5.6.2.6 tau_uri2Addr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

5.7 tau_dnr.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

5.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

5.7.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

5.7.2.1 tau_addr2Uri() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

5.7.2.2 tau_deInitDnr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

5.7.2.3 tau_DNRstatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Generated by Doxygen

CONTENTS ix

5.7.2.4 tau_getOwnAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

5.7.2.5 tau_initDnr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

5.7.2.6 tau_uri2Addr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

5.8 tau_dnr_types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

5.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

5.9 tau_marshall.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

5.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

5.9.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

5.9.2.1 tau_calcDatasetSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

5.9.2.2 tau_calcDatasetSizeByComId() . . . . . . . . . . . . . . . . . . . . . . . . . . 98

5.9.2.3 tau_initMarshall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

5.9.2.4 tau_marshall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

5.9.2.5 tau_marshallDs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

5.9.2.6 tau_unmarshall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

5.9.2.7 tau_unmarshallDs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

5.10 tau_marshall.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

5.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

5.10.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

5.10.2.1 tau_calcDatasetSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

5.10.2.2 tau_calcDatasetSizeByComId() . . . . . . . . . . . . . . . . . . . . . . . . . . 106

5.10.2.3 tau_initMarshall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

5.10.2.4 tau_marshall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

5.10.2.5 tau_marshallDs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

5.10.2.6 tau_unmarshall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

5.10.2.7 tau_unmarshallDs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

5.11 tau_tti.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

5.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

5.11.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

5.11.2.1 TTI_CACHED_CONSISTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

5.11.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Generated by Doxygen

x CONTENTS

5.11.3.1 tau_deInitTTI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

5.11.3.2 tau_getCstFctCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

5.11.3.3 tau_getCstFctInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

5.11.3.4 tau_getCstInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

5.11.3.5 tau_getCstVehCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

5.11.3.6 tau_getOpTrDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

5.11.3.7 tau_getOpTrnDirectoryStatusInfo() . . . . . . . . . . . . . . . . . . . . . . . . 117

5.11.3.8 tau_getOwnIds() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

5.11.3.9 tau_getStaticCstInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

5.11.3.10 tau_getTrDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

5.11.3.11 tau_getTrnCstCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

5.11.3.12 tau_getTrnVehCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

5.11.3.13 tau_getTTI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

5.11.3.14 tau_getVehInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

5.11.3.15 tau_getVehOrient() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

5.11.3.16 tau_initTTIaccess() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

5.12 tau_tti.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

5.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

5.12.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

5.12.2.1 tau_deInitTTI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

5.12.2.2 tau_getCstFctCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

5.12.2.3 tau_getCstFctInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

5.12.2.4 tau_getCstInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

5.12.2.5 tau_getCstVehCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

5.12.2.6 tau_getOpTrDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

5.12.2.7 tau_getOpTrnDirectoryStatusInfo() . . . . . . . . . . . . . . . . . . . . . . . . 130

5.12.2.8 tau_getOwnIds() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

5.12.2.9 tau_getStaticCstInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

5.12.2.10 tau_getTrDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

5.12.2.11 tau_getTrnCstCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Generated by Doxygen

CONTENTS xi

5.12.2.12 tau_getTrnVehCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

5.12.2.13 tau_getTTI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

5.12.2.14 tau_getVehInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

5.12.2.15 tau_getVehOrient() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

5.12.2.16 tau_initTTIaccess() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

5.13 tau_tti_types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

5.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

5.14 tau_xml.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

5.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

5.14.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

5.14.2.1 TRDP_SDT_DEFAULT_CMTHR . . . . . . . . . . . . . . . . . . . . . . . . . 141

5.14.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

5.14.3.1 tau_freeTelegrams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

5.14.3.2 tau_freeXmlDatasetConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

5.14.3.3 tau_freeXmlDoc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

5.14.3.4 tau_prepareXmlDoc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

5.14.3.5 tau_readXmlDatasetConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

5.14.3.6 tau_readXmlDeviceConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

5.14.3.7 tau_readXmlInterfaceConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

5.15 tau_xml.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

5.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

5.15.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

5.15.2.1 TRDP_DBG_DEFAULT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

5.15.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

5.15.3.1 TRDP_EXCHG_OPTION_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

5.15.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

5.15.4.1 tau_freeTelegrams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

5.15.4.2 tau_freeXmlDatasetConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

5.15.4.3 tau_freeXmlDoc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

5.15.4.4 tau_prepareXmlDoc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Generated by Doxygen

xii CONTENTS

5.15.4.5 tau_readXmlDatasetConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.15.4.6 tau_readXmlDeviceConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.15.4.7 tau_readXmlInterfaceConﬁg() . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

5.16 trdp_dllmain.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

5.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

5.17 trdp_if.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

5.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

5.17.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

5.17.2.1 tlc_closeSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

5.17.2.2 tlc_conﬁgSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

5.17.2.3 tlc_getETBTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

5.17.2.4 tlc_getInterval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

5.17.2.5 tlc_getOpTrainTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

5.17.2.6 tlc_getOwnIpAddress() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

5.17.2.7 tlc_getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

5.17.2.8 tlc_getVersionString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

5.17.2.9 tlc_init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

5.17.2.10 tlc_openSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

5.17.2.11 tlc_process() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

5.17.2.12 tlc_reinitSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

5.17.2.13 tlc_setETBTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5.17.2.14 tlc_setOpTrainTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5.17.2.15 tlc_terminate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

5.17.2.16 tlp_get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

5.17.2.17 tlp_getRedundant() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

5.17.2.18 tlp_publish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

5.17.2.19 tlp_put() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

5.17.2.20 tlp_republish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

5.17.2.21 tlp_request() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

5.17.2.22 tlp_resubscribe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Generated by Doxygen

CONTENTS xiii

5.17.2.23 tlp_setRedundant() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

5.17.2.24 tlp_subscribe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

5.17.2.25 tlp_unpublish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

5.17.2.26 tlp_unsubscribe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

5.17.2.27 trdp_isValidSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

5.17.2.28 trdp_sessionQueue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

5.18 trdp_if.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

5.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

5.18.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

5.18.2.1 trdp_isValidSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

5.18.2.2 trdp_sessionQueue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

5.19 trdp_if_light.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

5.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

5.19.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

5.19.2.1 tlc_closeSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

5.19.2.2 tlc_conﬁgSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

5.19.2.3 tlc_freeBuf() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

5.19.2.4 tlc_getETBTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

5.19.2.5 tlc_getInterval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

5.19.2.6 tlc_getJoinStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

5.19.2.7 tlc_getOpTrainTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

5.19.2.8 tlc_getOwnIpAddress() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

5.19.2.9 tlc_getPubStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

5.19.2.10 tlc_getRedStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

5.19.2.11 tlc_getStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

5.19.2.12 tlc_getSubsStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

5.19.2.13 tlc_getTcpListStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

5.19.2.14 tlc_getUdpListStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

5.19.2.15 tlc_getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

5.19.2.16 tlc_getVersionString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Generated by Doxygen

xiv CONTENTS

5.19.2.17 tlc_init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

5.19.2.18 tlc_openSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

5.19.2.19 tlc_process() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

5.19.2.20 tlc_reinitSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

5.19.2.21 tlc_resetStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

5.19.2.22 tlc_setETBTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.19.2.23 tlc_setOpTrainTopoCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.19.2.24 tlc_terminate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

5.19.2.25 tlm_abortSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

5.19.2.26 tlm_addListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

5.19.2.27 tlm_conﬁrm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

5.19.2.28 tlm_delListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

5.19.2.29 tlm_notify() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

5.19.2.30 tlm_readdListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

5.19.2.31 tlm_reply() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

5.19.2.32 tlm_replyQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

5.19.2.33 tlm_request() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

5.19.2.34 tlp_get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

5.19.2.35 tlp_getRedundant() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

5.19.2.36 tlp_publish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

5.19.2.37 tlp_put() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

5.19.2.38 tlp_republish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

5.19.2.39 tlp_request() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

5.19.2.40 tlp_resubscribe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

5.19.2.41 tlp_setRedundant() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

5.19.2.42 tlp_subscribe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

5.19.2.43 tlp_unpublish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

5.19.2.44 tlp_unsubscribe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

5.20 trdp_mdcom.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

5.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Generated by Doxygen

CONTENTS xv

5.20.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

5.20.2.1 trdp_mdCall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

5.20.2.2 trdp_mdCheckListenSocks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

5.20.2.3 trdp_mdCheckPending() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

5.20.2.4 trdp_mdCheckTimeouts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

5.20.2.5 trdp_mdConﬁrm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

5.20.2.6 trdp_mdFreeSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

5.20.2.7 trdp_mdGetTCPSocket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

5.20.2.8 trdp_mdReply() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

5.20.2.9 trdp_mdSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

5.21 trdp_mdcom.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

5.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

5.21.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

5.21.2.1 trdp_mdCall() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

5.21.2.2 trdp_mdCheckListenSocks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

5.21.2.3 trdp_mdCheckPending() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

5.21.2.4 trdp_mdCheckTimeouts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

5.21.2.5 trdp_mdConﬁrm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

5.21.2.6 trdp_mdFreeSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

5.21.2.7 trdp_mdGetTCPSocket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

5.21.2.8 trdp_mdReply() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

5.21.2.9 trdp_mdSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

5.22 trdp_pdcom.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

5.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

5.22.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

5.22.2.1 trdp_pdCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

5.22.2.2 trdp_pdCheckListenSocks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

5.22.2.3 trdp_pdCheckPending() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

5.22.2.4 trdp_pdDistribute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

5.22.2.5 trdp_pdHandleTimeOuts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Generated by Doxygen

xvi CONTENTS

5.22.2.6 trdp_pdInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

5.22.2.7 trdp_pdPut() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

5.22.2.8 trdp_pdReceive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

5.22.2.9 trdp_pdSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

5.22.2.10 trdp_pdSendQueued() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

5.22.2.11 trdp_pdUpdate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

5.23 trdp_pdcom.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

5.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.23.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.23.2.1 trdp_pdCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.23.2.2 trdp_pdCheckListenSocks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

5.23.2.3 trdp_pdCheckPending() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

5.23.2.4 trdp_pdDistribute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

5.23.2.5 trdp_pdHandleTimeOuts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

5.23.2.6 trdp_pdInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

5.23.2.7 trdp_pdPut() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

5.23.2.8 trdp_pdReceive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

5.23.2.9 trdp_pdSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

5.23.2.10 trdp_pdSendQueued() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

5.23.2.11 trdp_pdUpdate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5.24 trdp_private.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

5.24.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

5.24.2.1 TRDP_MD_ELE_ST_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

5.24.2.2 TRDP_SOCK_TYPE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

5.25 trdp_stats.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

5.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

5.25.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

5.25.2.1 tlc_getJoinStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

5.25.2.2 tlc_getPubStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Generated by Doxygen

CONTENTS xvii

5.25.2.3 tlc_getRedStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

5.25.2.4 tlc_getStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

5.25.2.5 tlc_getSubsStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

5.25.2.6 tlc_resetStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

5.25.2.7 trdp_initStats() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

5.25.2.8 trdp_pdPrepareStats() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

5.25.2.9 trdp_UpdateStats() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

5.26 trdp_stats.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

5.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.26.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.26.2.1 trdp_initStats() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.26.2.2 trdp_pdPrepareStats() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

5.27 trdp_types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

5.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

5.27.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.27.2.1 TRDP_FLAGS_DEFAULT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.27.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.27.3.1 TRDP_IP_ADDR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.27.3.2 TRDP_MARSHALL_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.27.3.3 TRDP_MD_CALLBACK_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

5.27.3.4 TRDP_PD_CALLBACK_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

5.27.3.5 TRDP_PRINT_DBG_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

5.27.3.6 TRDP_TIME_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

5.27.3.7 TRDP_UNMARSHALL_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

5.27.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

5.27.4.1 TRDP_DATA_TYPE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

5.27.4.2 TRDP_ERR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

5.27.4.3 TRDP_RED_STATE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

5.27.4.4 TRDP_REPLY_STATUS_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

5.27.4.5 TRDP_TO_BEHAVIOR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Generated by Doxygen

xviii CONTENTS

5.28 trdp_utils.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

5.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

5.28.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

5.28.2.1 trdp_checkSequenceCounter() . . . . . . . . . . . . . . . . . . . . . . . . . . 267

5.28.2.2 trdp_ﬁndMCjoins() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

5.28.2.3 trdp_getCurrentMaxSocketCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . 268

5.28.2.4 trdp_getSeqCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

5.28.2.5 trdp_initSockets() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

5.28.2.6 trdp_isAddressed() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

5.28.2.7 trdp_isInIPrange() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

5.28.2.8 trdp_packetSizeMD() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

5.28.2.9 trdp_packetSizePD() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

5.28.2.10 trdp_queueAppLast() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

5.28.2.11 trdp_queueDelElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

5.28.2.12 trdp_queueFindComId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

5.28.2.13 trdp_queueFindPubAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

5.28.2.14 trdp_queueFindSubAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

5.28.2.15 trdp_queueInsFirst() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.28.2.16 trdp_releaseSocket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.28.2.17 trdp_requestSocket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.28.2.18 trdp_resetSequenceCounter() . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

5.28.2.19 trdp_validTopoCounters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

5.29 trdp_utils.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

5.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

5.29.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

5.29.2.1 trdp_checkSequenceCounter() . . . . . . . . . . . . . . . . . . . . . . . . . . 279

5.29.2.2 trdp_ﬁndMCjoins() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

5.29.2.3 trdp_getCurrentMaxSocketCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . 280

5.29.2.4 trdp_getSeqCnt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

5.29.2.5 trdp_initSockets() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Generated by Doxygen

CONTENTS xix

5.29.2.6 trdp_initUncompletedTCP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

5.29.2.7 trdp_isAddressed() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

5.29.2.8 trdp_isInIPrange() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

5.29.2.9 trdp_packetSizeMD() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

5.29.2.10 trdp_packetSizePD() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

5.29.2.11 trdp_queueAppLast() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

5.29.2.12 trdp_queueDelElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

5.29.2.13 trdp_queueFindComId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

5.29.2.14 trdp_queueFindPubAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

5.29.2.15 trdp_queueFindSubAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

5.29.2.16 trdp_queueInsFirst() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

5.29.2.17 trdp_releaseSocket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

5.29.2.18 trdp_requestSocket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

5.29.2.19 trdp_resetSequenceCounter() . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

5.29.2.20 trdp_validTopoCounters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

5.30 trdp_xml.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

5.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

5.30.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

5.30.2.1 trdp_XMLClose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

5.30.2.2 trdp_XMLCountStartTag() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

5.30.2.3 trdp_XMLEnter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

5.30.2.4 trdp_XMLGetAttribute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

5.30.2.5 trdp_XMLLeave() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

5.30.2.6 trdp_XMLOpen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

5.30.2.7 trdp_XMLRewind() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

5.30.2.8 trdp_XMLSeekStartTag() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

5.30.2.9 trdp_XMLSeekStartTagAny() . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

5.31 trdp_xml.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

5.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

5.31.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Generated by Doxygen

xx CONTENTS

5.31.2.1 trdp_XMLClose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

5.31.2.2 trdp_XMLCountStartTag() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

5.31.2.3 trdp_XMLEnter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

5.31.2.4 trdp_XMLGetAttribute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

5.31.2.5 trdp_XMLLeave() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

5.31.2.6 trdp_XMLOpen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

5.31.2.7 trdp_XMLRewind() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

5.31.2.8 trdp_XMLSeekStartTag() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

5.31.2.9 trdp_XMLSeekStartTagAny() . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

5.32 vos_mem.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

5.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

5.32.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

5.32.2.1 vos_bsearch() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

5.32.2.2 vos_memAlloc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

5.32.2.3 vos_memCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

5.32.2.4 vos_memDelete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

5.32.2.5 vos_memFree() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

5.32.2.6 vos_memInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

5.32.2.7 vos_qsort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

5.32.2.8 vos_queueCreate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

5.32.2.9 vos_queueDestroy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

5.32.2.10 vos_queueReceive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

5.32.2.11 vos_queueSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

5.32.2.12 vos_strncat() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

5.32.2.13 vos_strncpy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

5.32.2.14 vos_strnicmp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

5.33 vos_mem.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

5.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

5.33.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

5.33.2.1 VOS_MEM_BLOCKSIZES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Generated by Doxygen

CONTENTS xxi

5.33.2.2 VOS_MEM_PREALLOCATE . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

5.33.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

5.33.3.1 vos_bsearch() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

5.33.3.2 vos_memAlloc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

5.33.3.3 vos_memCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

5.33.3.4 vos_memDelete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

5.33.3.5 vos_memFree() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

5.33.3.6 vos_memInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

5.33.3.7 vos_qsort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

5.33.3.8 vos_queueCreate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

5.33.3.9 vos_queueDestroy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

5.33.3.10 vos_queueReceive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

5.33.3.11 vos_queueSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

5.33.3.12 vos_strncat() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.33.3.13 vos_strncpy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.33.3.14 vos_strnicmp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

5.34 vos_shared_mem.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

5.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

5.34.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

5.34.2.1 vos_sharedClose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

5.34.2.2 vos_sharedOpen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

5.35 vos_sock.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

5.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

5.35.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.35.2.1 VOS_MAX_SOCKET_CNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.35.2.2 VOS_TTL_MULTICAST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.35.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.35.3.1 vos_determineBindAddr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.35.3.2 vos_dottedIP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

5.35.3.3 vos_getInterfaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Generated by Doxygen

xxii CONTENTS

5.35.3.4 vos_htonl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

5.35.3.5 vos_htonll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

5.35.3.6 vos_htons() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

5.35.3.7 vos_ipDotted() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

5.35.3.8 vos_isMulticast() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

5.35.3.9 vos_netIfUp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

5.35.3.10 vos_ntohl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

5.35.3.11 vos_ntohll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

5.35.3.12 vos_ntohs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

5.35.3.13 vos_select() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

5.35.3.14 vos_sockAccept() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

5.35.3.15 vos_sockBind() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

5.35.3.16 vos_sockClose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

5.35.3.17 vos_sockConnect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

5.35.3.18 vos_sockGetMAC() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

5.35.3.19 vos_sockInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

5.35.3.20 vos_sockJoinMC() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

5.35.3.21 vos_sockLeaveMC() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

5.35.3.22 vos_sockListen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

5.35.3.23 vos_sockOpenTCP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.35.3.24 vos_sockOpenUDP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.35.3.25 vos_sockReceiveTCP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.35.3.26 vos_sockReceiveUDP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

5.35.3.27 vos_sockSendTCP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

5.35.3.28 vos_sockSendUDP() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

5.35.3.29 vos_sockSetMulticastIf() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

5.35.3.30 vos_sockSetOptions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

5.35.3.31 vos_sockTerm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

5.36 vos_thread.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

5.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

Generated by Doxygen

CONTENTS xxiii

5.36.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.36.2.1 vos_addTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.36.2.2 vos_clearTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.36.2.3 vos_cmpTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.36.2.4 vos_cyclicThread() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

5.36.2.5 vos_divTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

5.36.2.6 vos_getTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.36.2.7 vos_getTimeStamp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.36.2.8 vos_getUuid() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.36.2.9 vos_mulTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.36.2.10 vos_mutexCreate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

5.36.2.11 vos_mutexDelete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

5.36.2.12 vos_mutexLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

5.36.2.13 vos_mutexTryLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

5.36.2.14 vos_mutexUnlock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

5.36.2.15 vos_semaCreate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.36.2.16 vos_semaDelete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.36.2.17 vos_semaGive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.36.2.18 vos_semaTake() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

5.36.2.19 vos_subTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

5.36.2.20 vos_threadCreate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

5.36.2.21 vos_threadDelay() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

5.36.2.22 vos_threadInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

5.36.2.23 vos_threadIsActive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

5.36.2.24 vos_threadSelf() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

5.36.2.25 vos_threadTerm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.36.2.26 vos_threadTerminate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.37 vos_types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.37.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

Generated by Doxygen

xxiv CONTENTS

5.37.2.1 VOS_PRINT_DBG_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.37.2.2 VOS_TIMEVAL_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.37.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.37.3.1 VOS_ERR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.37.3.2 VOS_LOG_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

5.38 vos_utils.c File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

5.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

5.38.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

5.38.2.1 vos_crc32() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

5.38.2.2 vos_getErrorString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.38.2.3 vos_getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.38.2.4 vos_getVersionString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.38.2.5 vos_init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.38.2.6 vos_sc32() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.38.2.7 vos_terminate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.39 vos_utils.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

5.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

5.39.2 Macro Deﬁnition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.2.1 INITFCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.2.2 VOS_MAX_ERR_STR_SIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.2.3 VOS_MAX_FRMT_SIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.2.4 VOS_MAX_PRNT_STR_SIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.3.1 vos_crc32() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.39.3.2 vos_getErrorString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.39.3.3 vos_getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.39.3.4 vos_getVersionString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

5.39.3.5 vos_init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

5.39.3.6 vos_sc32() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

5.39.3.7 vos_terminate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Index 369

Generated by Doxygen

Chapter 1

The TRDP Light Library API Speciﬁcation

1.1 General Information

1.1.1 Purpose

The TRDP protocol has been deﬁned as the standard communication protocol in IP-enabled trains. It allows commu-

nication via process data (periodically transmitted data using UDP/IP) and message data (client - server messaging

using UDP/IP or TCP/IP) This document describes the light API of the TRDP Library.

1.1.2 Scope

The intended audience of this document is the developers and project members of the TRDP project. TRDP Client

Applications are programs using the TRDP protocol library to access the services of TRDP. Programmers developing

such applications are the main target audience for this documentation.

1.1.3 Related documents

TCN-TRDP2-D-BOM-004-01 IEC61375-2-3_CD_ANNEXA Protocol deﬁnition of the TRDP standard

1.1.4 Abbreviations and Deﬁnitions

-API Application Programming Interface -ECN Ethernet Consist Network -TRDP Train Real-time Data Protocol

-TCMS Train Control Management System

2 The TRDP Light Library API Speciﬁcation

1.2 Terminology

The API documented here is mainly concerned with three bodies of code:

•TRDP Client Applications (or 'client applications' for short): These are programs using the API to access the

services of TRDP. Programmers developing such applications are the main target audience for this documen-

tation.

•TRDP Light Implementations (or just 'TRDP implementation'): These are libraries realising the API as doc-

umented here. Programmers developing such implementations will ﬁnd useful deﬁnitions about syntax and

semantics of the API wihtin this documentation.

•VOS Subsystem (Virtual Operating System): An OS and hardware abstraction layer which offers memory,

networking, threading, queues and debug functions. The VOS API is documented here.

The following diagram shows how these pieces of software are interrelated.

application process

TLP_publish

TLP_subscribe

TLC_getInterval()

select()

application data handling

TLC_process()

TLP_subscribe()

PD Callback

TLP_publish()

more input

Main workloop

comID,

status

Received

data handling

Received

data handling

TLP_put()

TLC_openSession

TLC_init

Shutdown

TLC_closeSession()

TLC_terminate()

Figure 1.1 Sample client workﬂow

Generated by Doxygen

1.3 Conventions of the API 3

1.3 Conventions of the API

The API comprises a set of C header ﬁles that can also be used from client applications written in C++. These

header ﬁles are contained in a directory named trdp/api and a subdirectory called trdp/vos/api with dec-

larations not topical to TRDP but needed by the stack. Client applications shall include these header ﬁles like:

#include "trdp_if_light.h"

and, if VOS functions are needed, also the corresponding headers:

#include "vos_thread.h"

for example.

The subdirectory trdp/doc contains ﬁles needed for the API documentation.

Generally client application source code including API headers will only compile if the parent directory of the trdp

directory is part of the include path of the used compiler. No other subdirectories of the API should be added to the

compiler's include path.

The client API doesn't support a "catch-all" header ﬁle that includes all declarations in one step; rather the client

application has to include individual headers for each feature set it wants to use.

Generated by Doxygen

4 The TRDP Light Library API Speciﬁcation

Generated by Doxygen

Chapter 2

Data Structure Index

2.1 Data Structures

Here are the data structures with brief descriptions:

DNS_HEADER

DNS header structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

GNU_PACKED

Types for ETB control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

PD_ELE

Queue element for PD packets to send or receive . . . . . . . . . . . . . . . . . . . . . . . . 22

TAU_MARSHALL_INFO_T

Marshalling info, used to and from wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

TCN_URI

TCN-DNS simpliﬁed header structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

TRDP_CLTR_CST_INFO_T

Closed train consists information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

TRDP_COMID_DSID_MAP_T

ComId - data set mapping element deﬁnition . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

TRDP_CONSIST_INFO_T

Consist information structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

TRDP_DATASET

Dataset deﬁnition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

TRDP_DATASET_ELEMENT_T

Dataset element deﬁnition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

TRDP_DBG_CONFIG_T

Control for debug output device/ﬁle on application level . . . . . . . . . . . . . . . . . . . . . 30

TRDP_DNS_REPLY

TCN-DNS Reply telegram TCN_DNS_REP_DS . . . . . . . . . . . . . . . . . . . . . . . . . 31

TRDP_DNS_REQUEST

TCN-DNS Request telegram TCN_DNS_REQ_DS . . . . . . . . . . . . . . . . . . . . . . . 32

TRDP_ETB_INFO_T

Types for train conﬁguration information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

TRDP_FUNCTION_INFO_T

Function/device information structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

TRDP_HANDLE

Hidden handle deﬁnition, used as unique addressing item . . . . . . . . . . . . . . . . . . . . 35

TRDP_LIST_STATISTICS_T

Information about a particular MD listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

TRDP_MARSHALL_CONFIG_T

Marshaling/unmarshalling conﬁguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

6 Data Structure Index

TRDP_MD_CONFIG_T

Default MD conﬁguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

TRDP_MD_INFO_T

Message data info from received telegram; allows the application to generate responses . . . 39

TRDP_MD_STATISTICS_T

Structure containing all general MD statistics information . . . . . . . . . . . . . . . . . . . . 40

TRDP_MEM_CONFIG_T

Enumeration type for memory pre-fragmentation, reuse of VOS deﬁnition . . . . . . . . . . . . 41

TRDP_MEM_STATISTICS_T

Structure containing all general memory statistics information . . . . . . . . . . . . . . . . . . 42

TRDP_PD_CONFIG_T

Default PD conﬁguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

TRDP_PD_INFO_T

Process data info from received telegram; allows the application to generate responses . . . . 43

TRDP_PD_STATISTICS_T

Structure containing all general PD statistics information . . . . . . . . . . . . . . . . . . . . 44

TRDP_PROCESS_CONFIG_T

Various ﬂags/general TRDP options for library initialization . . . . . . . . . . . . . . . . . . . 45

TRDP_PROP_T

Application deﬁned properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

TRDP_PUB_STATISTICS_T

Table containing particular PD publishing information . . . . . . . . . . . . . . . . . . . . . . 46

TRDP_RED_STATISTICS_T

A table containing PD redundant group information . . . . . . . . . . . . . . . . . . . . . . . 47

TRDP_SDT_PAR_T

Types to read out the XML conﬁguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

TRDP_SEND_PARAM_T

Quality/type of service and time to live . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

TRDP_SEQ_CNT_ENTRY_T

Tuples of last received sequence counter per comId . . . . . . . . . . . . . . . . . . . . . . . 49

TRDP_SESSION

Session/application variables store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

TRDP_SOCKET_TCP

TCP parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

TRDP_SOCKETS

Socket item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

TRDP_STATISTICS_REQUEST_T

TRDP statistics type deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

TRDP_STATISTICS_T

Structure containing all general memory, PD and MD statistics information . . . . . . . . . . . 53

TRDP_SUBS_STATISTICS_T

Table containing particular PD subscription information . . . . . . . . . . . . . . . . . . . . . 54

TRDP_VEHICLE_INFO_T

Vehicle information structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

TRDP_XML_DOC_HANDLE_T

Parsed XML document handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

VOS_SOCK_OPT_T

Common socket options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

VOS_VERSION_T

Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Generated by Doxygen

Chapter 3

File Index

3.1 File List

Here is a list of all documented ﬁles with brief descriptions:

iec61375-2-3.h

All deﬁnitions from IEC 61375-2-3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

tau_cstinfo.c

Functions for consist information access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

tau_ctrl.c

Functions for train switch control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

tau_ctrl.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

tau_ctrl_types.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

tau_dnr.c

Functions for domain name resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

tau_dnr.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

tau_dnr_types.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

tau_marshall.c

Marshalling functions for TRDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

tau_marshall.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

tau_tti.c

Functions for train topology information access . . . . . . . . . . . . . . . . . . . . . . . . . 112

tau_tti.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

tau_tti_types.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

tau_xml.c

Functions for XML ﬁle parsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

tau_xml.h

TRDP utility interface deﬁnitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

trdp_dllmain.c

Windows DLL main function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

trdp_if.c

Functions for ECN communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

trdp_if.h

Typedefs for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

8 File Index

trdp_if_light.h

TRDP Light interface functions (API) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

trdp_mdcom.c

Functions for MD communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

trdp_mdcom.h

Functions for MD communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

trdp_pdcom.c

Functions for PD communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

trdp_pdcom.h

Functions for PD communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

trdp_private.h

Typedefs for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

trdp_stats.c

Statistics functions for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . 245

trdp_stats.h

Statistics for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

trdp_types.h

Typedefs for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

trdp_utils.c

Helper functions for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

trdp_utils.h

Common utilities for TRDP communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

trdp_xml.c

Simple XML parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

trdp_xml.h

Simple XML parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

vos_mem.c

Memory functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

vos_mem.h

Memory and queue functions for OS abstraction . . . . . . . . . . . . . . . . . . . . . . . . . 309

vos_shared_mem.h

Shared Memory functions for OS abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . 319

vos_sock.h

Typedefs for OS abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

vos_thread.h

Threading functions for OS abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

vos_types.h

Typedefs for OS abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

vos_utils.c

Common functions for VOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

vos_utils.h

Typedefs for OS abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Generated by Doxygen

Chapter 4

Data Structure Documentation

4.1 DNS_HEADER Struct Reference

DNS header structure.

4.1.1 Detailed Description

DNS header structure.

The documentation for this struct was generated from the following ﬁle:

•tau_dnr.c

4.2 GNU_PACKED Struct Reference

Types for ETB control.

#include <trdp_private.h>

Data Fields

• UINT8 trnVehNo

vehicle sequence number within the train with vehicle 01 being the ﬁrst vehicle in ETB reference direction 1 as deﬁned

in IEC61375-2-5 value range: 0..63 a value of 0 indicates that this vehicle has been inserted by correction

• ANTIVALENT8 isLead

vehicle is leading

• UINT8 leadDir

vehicle leading direction 0 = not relevant 1 = leading direction 1 2 = leading direction 2

• UINT8 vehOrient

vehicle orientation 0 = not known (corrected vehicle) 1 = same as operational train direction 2 = inverse to operational

train direction

• TRDP_SHORT_VERSION_T version

telegram version information, main_version = 1, sub_version = 0

10 Data Structure Documentation

• UINT16 reserved01

reserved (=0)

• UINT8 trnCstNo

own TCN consist number (= 1..32)

• UINT8 reserved02

reserved (=0)

• UINT8 ownOpCstNo

own operational address (= 1..32) = 0 if unknown (e.g.

• UINT8 reserved03

reserved (=0)

• UINT32 cstTopoCount

Consist topology counter.

• UINT32 trnTopoCount

Train directory topology counter.

• UINT32 opTrnTopoCount

Operational Train topology counter.

• ANTIVALENT8 wasLead

consist was leading, '01'B = false, '10'B = true

• ANTIVALENT8 reqLead

leading request, '01'B = false, '10'B = true

• UINT8 reqLeadDir

(request) leading direction, '01'B = consist direction 1, '10'B = consist direction 2

• ANTIVALENT8 accLead

accept remote leading request, '01'B = false/not accepted, '10'B = true/accepted

• ANTIVALENT8 clearConfComp

clear conﬁrmed composition, '01'B = false, '10'B = true

• ANTIVALENT8 corrRequest

request conﬁrmation, '01'B = false, '10'B = true

• ANTIVALENT8 corrInfoSet

correction info set, '01'B = false, '10'B = true

• ANTIVALENT8 compStored

corrected composition stored, '01'B = false, '10'B = true

• ANTIVALENT8 sleepRequest

request sleep mode, '01'B = false, '10'B = true

• UINT8 leadVehOfCst

position of leading vehicle in consist, 0..31 (1: ﬁrst vehicle in consist in Direction 1, 2: second vehicle, etc.)

• UINT8 reserved04

reserved (=0)

• UINT16 reserved05

reserved (=0)

• UINT8 reserved06

reserved (=0)

• UINT8 confVehCnt

number of conﬁrmed vehicles in train (1..63)

• TRDP_CONF_VEHICLE_T confVehList [TRDP_MAX_VEH_CNT]

dynamic ordered list of conﬁrmed vehicles in train, starting with vehicle at train head, see sub-clause 5.3.3.2.6

• TRDP_ETB_CTRL_VDP_T safetyTrail

ETBCTRL-VDP trailer, completely set to 0 == not used.

• UINT8 reserved01

reserved (=0)

•TRDP_NET_LABEL_T deviceName

Generated by Doxygen

4.2 GNU_PACKED Struct Reference 11

function device of ECSC which sends the telegram

• UINT8 inhibit

inauguration inhibit 0 = no inhibit request 1 = inhibit request

• UINT8 leadingReq

leading request 0 = no leading request 1 = leading request

• UINT8 leadingDir

leading direction 0 = no leading request 1 = leading request direction 1 2 = leading request direction 2

• UINT8 sleepReq

sleep request 0 = no sleep request 1 = sleep request

• UINT16 lifesign

wrap-around counter, incremented with each produced datagram.

• UINT8 ecspState

ECSP state indication 0 = ECSP not operational(initial value) 1 = ECSP in operation.

• UINT8 etbInhibit

inauguration inhibit indication 0 = n/a (default) 1 = inhibit not requested on ETB 2 = inhibit set on local ETBN 3 = inhibit

set on remote ETBN 4 = inhibit set on local and remote ETBN

• UINT8 etbLength

indicates train lengthening in case train inauguration is inhibit 0 = no lengthening (default) 1 = lengthening detected

• UINT8 etbShort

indicates train shortening in case train inauguration is inhibit 0 = no shortening (default) 1 = shortening detected

• UINT16 reserved02

reserved (=0)

• UINT8 etbLeadState

indication of local consist leadership 5 = consist not leading (initial value) 6 = consist is leading requesting 9 = consist

is leading 10 = leading conﬂict other values are not allowed

• UINT8 etbLeadDir

direction of the leading end car in the local consist 0 = unknown (default) 1 = TCN direction 1 2 = TCN direction 2

other values are not allowed

• UINT8 ttdbSrvState

TTDB server state indication 0 = n/a (initial value) 1 = Leader (default) 2 = Follower 3 = Error.

• UINT8 dnsSrvState

DNS server state indication 0 = n/a (initial value) 1 = Leader (default) 2 = Follower 3 = Error.

• UINT8 trnDirState

train directory state 1 = UNCONFIRMED 2 = CONFIRMED other values are not allowed

• UINT8 opTrnDirState

train directory state 1 = INVALID 2 = VALID 4 = SHARED other values are not allowed

• UINT8 sleepCtrlState

sleep control state (option) 0 = option not available 1 = RegularOperation 2 = WaitForSleepMode 3 = PrepareFor←-

SleepMode

• UINT8 sleepReqCnt

number of sleep requests (option) value range: 0..63, not used = 0

• UINT32 opTrnTopoCnt

operational train topology counter

• UINT8 command

conﬁrmation order 1 = conﬁrmation/correction request 2 = un-conﬁrmation request

• UINT16 confVehCnt

number of conﬁrmed vehicles in the train (1..63).

• TRDP_OP_VEHICLE_T confVehList [TRDP_MAX_VEH_CNT]

ordered list of conﬁrmed vehicles in the train, starting with vehicle at train head, see chapter 5.3.3.2.10.

• UINT8 status

status of storing correction info 0 = correctly stored 1 = not stored

Generated by Doxygen

12 Data Structure Documentation

• UINT32 reqSafetyCode

SC-32 value of the request message.

• UINT8 byPassCtrl

ETBN bypass control 0 = no action (keep old state) 1 = no bypass 2 = activate bypass.

• UINT8 txCtrl

ETBN transmission control 0 = no action (keep old state) 1 = activate sending on ETB (default) 2 = stop sending on

ETB.

• UINT8 slCtrl

sleep mode control (option) 0 = no action (keep old state) 1 = deactivate sleep mode 2 = activate sleep mode (line

activity sensing)

• UINT8 etbnState

state indication of the (active) ETBN 0 = ETBN not operational(initial value) 1 = ETBN in operation

• UINT8 etbnInaugState

ETBN inauguration state as deﬁned in IEC61375-2-5 0 = init 1 = not inaugurated 2 = inaugurated 3 = ready for

inauguration.

• UINT8 etbnPosition

position of the ETBN 0 = unknown (default) 1 = single node 2 = middle node 3 = end node TCN direction 1 4 = end

node TCN direction 2

• UINT8 etbnRole

ETBN node role as deﬁned in IEC61375-2-5 0 = undeﬁned 1 = master (redundancy leader) 2 = backup (redundancy

follower) 3 = not redundant.

• BITSET8 etbLineState

indication of ETB line status (FALSE == not trusted, TRUE == trusted) bit0 = line A ETBN direction 1 bit1 = line B

ETBN direction 1 bit2 = line C ETBN direction 1 bit3 = line D ETBN direction 1 bit4 = line A ETBN direction 2 bit5 =

line B ETBN direction 2 bit6 = line C ETBN direction 2 bit7 = line D ETBN direction 2

• UINT8 byPassState

state of bypass function 0 = bypass disabled 1 = bypass enabled

• UINT8 slState

sleep mode state (option) 0 = no sleep mode 1 = sleep mode active (line activity sensing)

• UINT32 etbTopoCnt

ETB topography counter.

• TRDP_TRAIN_NET_DIR_T trnNetDir

dynamic train info

• UINT8 ver

Version - incremented for incompatible changes.

• UINT8 rel

Release - incremented for compatible changes.

• UINT32 reserved01

reserved (=0)

• TRDP_SHORT_VERSION_T userDataVersion

version of the vital ETBCTRL telegram mainVersion = 1, subVersion = 0

• UINT32 safeSeqCount

safe sequence counter, as deﬁned in B.9

• UINT32 safetyCode

checksum, as deﬁned in B.9

•TRDP_UUID_T cstUUID

UUID of the consist, provided by ETBN (TrainNetworkDirectory) Reference to static consist attributes 0 if not available

(e.g.

• UINT32 cstTopoCnt

consist topology counter provided with the CSTINFO 0 if no CSTINFO available

• UINT8 cstOrient

consist orientation '01'B = same as train direction '10'B = inverse to train direction

Generated by Doxygen

4.2 GNU_PACKED Struct Reference 13

• UINT8 cstCnt

number of consists in train; range: 1..63

• TRDP_CONSIST_T cstList [TRDP_MAX_CST_CNT]

consist list.

• UINT32 trnTopoCnt

trnTopoCnt value ctrlType == 0: actual value ctrlType == 1: set to 0

• UINT8 etbId

identiﬁcation of the ETB the TTDB is computed for bit0: ETB0 (operational network) bit1: ETB1 (multimedia network)

bit2: ETB2 (other network) bit3: ETB3 (other network)

•TRDP_NET_LABEL_T vehId

Unique vehicle identiﬁer, application deﬁned (e.g.

• UINT8 opVehNo

operational vehicle sequence number in train value range 1..63

• UINT8 opCstNo

operational consist number in train (1..63)

• UINT8 opCstOrient

consist orientation '00'B = not known (corrected vehicle) '01'B = same as operational train direction '10'B = inverse to

operational train direction

•TRDP_NET_LABEL_T trnId

train identiﬁer, application deﬁned (e.g.

•TRDP_NET_LABEL_T trnOperator

train operator, e.g.

• UINT32 crc

sc-32 computed over record (seed value: 'FFFFFFFF'H)

• UINT8 opTrnOrient

operational train orientation '00'B = unknown '01'B = same as train direction '10'B = inverse to train direction

• UINT8 opCstCnt

number of consists in train (1..63)

• TRDP_OP_CONSIST_T opCstList [TRDP_MAX_CST_CNT]

operational consist list starting with op.

• UINT8 reserved05

reserved for future use (= 0)

• UINT8 opVehCnt

number of vehicles in train (1..63)

• TRDP_OP_VEHICLE_T opVehList [TRDP_MAX_VEH_CNT]

operational vehicle list starting with op.

• TRDP_OP_TRAIN_DIR_STATE_T state

operational state of the train

• UINT32 cstNetProp

consist network properties bit0..1: consist orientation bit2..7: 0 bit8..13: ETBN Id bit14..15: 0 bit16..21: subnet Id

bit24..29: CN Id bit30..31: 0

• UINT16 entryCnt

number of entries in train network directory

• TRDP_TRAIN_NET_DIR_ENTRY_T trnNetDir [TRDP_MAX_CST_CNT]

train network directory

• TRDP_OP_TRAIN_DIR_T opTrnDir

operational directory

• TRDP_TRAIN_DIR_T trnDir

train directory

• UINT32 sequenceCounter

Unique counter (autom incremented)

Generated by Doxygen

14 Data Structure Documentation

• UINT16 protocolVersion

ﬁx value for compatibility (set by the API)

• UINT16 msgType

of datagram: PD Request (0x5072) or PD_MSG (0x5064)

• UINT32 comId

set by user: unique id

• UINT32 datasetLength

length of the data to transmit 0...1432

• UINT32 reserved

before used for ladder support

• UINT32 replyComId

used in PD request

• UINT32 replyIpAddress

used for PD request

• UINT32 frameCheckSum

CRC32 of header.

• INT32 replyStatus

0 = OK

• UINT8 sessionID [16u]

UUID as a byte stream.

• UINT32 replyTimeout

in us

• UINT8 sourceURI [32u]

User part of URI.

• UINT8 destinationURI [32u]

User part of URI.

• PD_HEADER_T frameHead

Packet header in network byte order.

• UINT8 data [TRDP_MAX_PD_DATA_SIZE]

data ready to be sent or received (with CRCs)

4.2.1 Detailed Description

Types for ETB control.

TRDP PD packet.

TRDP message data header - network order and alignment.

TRDP process data header - network order and alignment.

Complete TTDB structure.

Train network directory structure.

Train network directory entry structure acc.

Operational Train directory status info structure.

Operational train structure.

Operational train directory state.

Generated by Doxygen

4.2 GNU_PACKED Struct Reference 15

Operational consist structure.

Operational vehicle structure.

TCN train directory.

CSTINFO Control telegram.

TCN consist structure.

Version information for communication buffers.

to IEC61375-2-5

4.2.2 Field Documentation

4.2.2.1 confVehCnt

UINT16 GNU_PACKED::confVehCnt

number of conﬁrmed vehicles in the train (1..63).

4.2.2.2 confVehList

TRDP_OP_VEHICLE_T GNU_PACKED::confVehList[TRDP_MAX_VEH_CNT]

ordered list of conﬁrmed vehicles in the train, starting with vehicle at train head, see chapter 5.3.3.2.10.

Parameters 'isLead' and 'leadDir' to be set to 0

4.2.2.3 cstList

TRDP_CONSIST_T GNU_PACKED::cstList

consist list.

consist list ordered list starting with trnCstNo == 1 Note: This is a variable size array, only opCstCnt array elements

are present on the network and for crc computation

If trnCstNo >0 this shall be an ordered list starting with trnCstNo == 1 (exactly the same as in structure TRAIN←-

_DIRECTORY). If trnCstNo == 0 it is not mandatory to list all consists (only consists which should send CSTINFO

telegram). The parameters 'trnCstNo' and 'cstOrient' are optional and can be set to 0.

Generated by Doxygen

16 Data Structure Documentation

4.2.2.4 cstUUID

TRDP_UUID_T GNU_PACKED::cstUUID

UUID of the consist, provided by ETBN (TrainNetworkDirectory) Reference to static consist attributes 0 if not avail-

able (e.g.

unique consist identiﬁer

Reference to static consist attributes, 0 if not available (e.g.

correction)

4.2.2.5 datasetLength

UINT32 GNU_PACKED::datasetLength

length of the data to transmit 0...1432

deﬁned by user: length of data to transmit

4.2.2.6 deviceName

TRDP_NET_LABEL_T GNU_PACKED::deviceName

function device of ECSC which sends the telegram

function device of ED which sends the telegram

4.2.2.7 etbId

UINT8 GNU_PACKED::etbId

identiﬁcation of the ETB the TTDB is computed for bit0: ETB0 (operational network) bit1: ETB1 (multimedia network)

bit2: ETB2 (other network) bit3: ETB3 (other network)

identiﬁcation of the ETB the TTDB is computed for 0: ETB0 (operational network) 1: ETB1 (multimedia network) 2:

ETB2 (other network) 3: ETB3 (other network)

4.2.2.8 etbTopoCnt

UINT32 GNU_PACKED::etbTopoCnt

ETB topography counter.

set by user: ETB to use, '0' for consist local trafﬁc

train network directory CRC

Generated by Doxygen

4.2 GNU_PACKED Struct Reference 17

4.2.2.9 inhibit

UINT8 GNU_PACKED::inhibit

inauguration inhibit 0 = no inhibit request 1 = inhibit request

ETBN inhibit 0 = no action (keep old state) 1 = no inhibit request 2 = inhibit request.

4.2.2.10 isLead

ANTIVALENT8 GNU_PACKED::isLead

vehicle is leading

consist contains leading vehicle, '01'B = false, '10'B = true

4.2.2.11 leadDir

UINT8 GNU_PACKED::leadDir

vehicle leading direction 0 = not relevant 1 = leading direction 1 2 = leading direction 2

'vehicle leading direction 0 = not relevant 1 = leading direction 1 2 = leading direction 2

4.2.2.12 leadVehOfCst

UINT8 GNU_PACKED::leadVehOfCst

position of leading vehicle in consist, 0..31 (1: ﬁrst vehicle in consist in Direction 1, 2: second vehicle, etc.)

position of leading vehicle in consist range 0...32 0 = not deﬁned 1 = ﬁrst vehicle in consist in direction 1 2 = second

vehicle etc.

4.2.2.13 lifesign

UINT16 GNU_PACKED::lifesign

wrap-around counter, incremented with each produced datagram.

4.2.2.14 msgType

UINT16 GNU_PACKED::msgType

of datagram: PD Request (0x5072) or PD_MSG (0x5064)

of datagram: Mn, Mr, Mp, Mq, Mc or Me

Generated by Doxygen

18 Data Structure Documentation

4.2.2.15 opCstList

TRDP_OP_CONSIST_T GNU_PACKED::opCstList[TRDP_MAX_CST_CNT]

operational consist list starting with op.

consist #1 Note: This is a variable size array, only opCstCnt array elements are present

4.2.2.16 opTrnDirState

UINT8 GNU_PACKED::opTrnDirState

train directory state 1 = INVALID 2 = VALID 4 = SHARED other values are not allowed

Operational train directory status: '01'B == invalid, '10'B == valid, '100'B == shared.

4.2.2.17 opTrnTopoCnt

UINT32 GNU_PACKED::opTrnTopoCnt

operational train topology counter

set by user: direction/side critical, '0' if ignored

operational train topology counter computed as deﬁned in 5.3.3.2.16 (seed value : trnTopoCnt)

operational train topology counter set to 0 if opTrnDirState == invalid

operational train topocounter value of the operational train directory the correction is based on

4.2.2.18 opVehList

TRDP_OP_VEHICLE_T GNU_PACKED::opVehList[TRDP_MAX_VEH_CNT]

operational vehicle list starting with op.

vehicle #1 Note: This is a variable size array, only opCstCnt array elements are present

4.2.2.19 ownOpCstNo

UINT8 GNU_PACKED::ownOpCstNo

own operational address (= 1..32) = 0 if unknown (e.g.

operational consist number the vehicle belongs to

after Inauguration)

Generated by Doxygen

4.2 GNU_PACKED Struct Reference 19

4.2.2.20 protocolVersion

UINT16 GNU_PACKED::protocolVersion

ﬁx value for compatibility (set by the API)

ﬁx value for compatibility

4.2.2.21 reserved01 [1/2]

UINT16 GNU_PACKED::reserved01

reserved (=0)

reserved for future use (= 0)

4.2.2.22 reserved01 [2/2]

UINT8 GNU_PACKED::reserved01

reserved (=0)

reserved for future use (= 0)

4.2.2.23 reserved02 [1/2]

UINT16 GNU_PACKED::reserved02

reserved (=0)

reserved (= 0)

reserved for future use (= 0)

4.2.2.24 reserved02 [2/2]

UINT16 GNU_PACKED::reserved02

reserved (=0)

reserved (= 0)

4.2.2.25 reserved03

UINT8 GNU_PACKED::reserved03

reserved (=0)

reserved for future use (= 0)

Generated by Doxygen

20 Data Structure Documentation

4.2.2.26 reserved04

UINT8 GNU_PACKED::reserved04

reserved (=0)

reserved for future use (= 0)

4.2.2.27 reserved06

UINT8 GNU_PACKED::reserved06

reserved (=0)

reserved for future use (= 0)

4.2.2.28 safetyTrail

TRDP_ETB_CTRL_VDP_T GNU_PACKED::safetyTrail

ETBCTRL-VDP trailer, completely set to 0 == not used.

ETBCTRL-VDP trailer, parameter 'safeSequCount' == 0 completely set to 0 == not used.

ETBCTRL-VDP trailer, parameter 'safeSequCount' == 0 completely set to 0 == SDTv2 not used.

ETBCTRL-VDP trailer, completely set to 0 == SDTv2 not used.

4.2.2.29 trnCstNo

UINT8 GNU_PACKED::trnCstNo

own TCN consist number (= 1..32)

sequence number of consist in train with vehicle 01 being the ﬁrst vehicle in ETB reference direction 1 as deﬁned in

IEC61375-2-5, value range: 1..63, 0 = inserted by correction

train consist number telegram control type 0 = with trnTopoCnt tracking 1 = without trnTopoCnt tracking

Sequence number of consist in train (1..63)

4.2.2.30 trnDirState

UINT8 GNU_PACKED::trnDirState

train directory state 1 = UNCONFIRMED 2 = CONFIRMED other values are not allowed

TTDB status: '01'B == unconﬁrmed, '10'B == conﬁrmed.

Generated by Doxygen

4.2 GNU_PACKED Struct Reference 21

4.2.2.31 trnId

TRDP_NET_LABEL_T GNU_PACKED::trnId

train identiﬁer, application deﬁned (e.g.

'ICE75', 'IC346'), informal

4.2.2.32 trnNetDir

TRDP_TRAIN_NET_DIR_T GNU_PACKED::trnNetDir

dynamic train info

network directory

4.2.2.33 trnOperator

TRDP_NET_LABEL_T GNU_PACKED::trnOperator

train operator, e.g.

'trenitalia.it', informal

4.2.2.34 trnTopoCnt

UINT32 GNU_PACKED::trnTopoCnt

trnTopoCnt value ctrlType == 0: actual value ctrlType == 1: set to 0

computed as deﬁned in 5.3.3.2.16 (seed value: etbTopoCnt)

4.2.2.35 trnVehNo

UINT8 GNU_PACKED::trnVehNo

vehicle sequence number within the train with vehicle 01 being the ﬁrst vehicle in ETB reference direction 1 as

deﬁned in IEC61375-2-5 value range: 0..63 a value of 0 indicates that this vehicle has been inserted by correction

vehicle sequence number within the train with vehicle 01 being the ﬁrst vehicle in ETB reference direction 1 as

deﬁned in IEC61375-2-5, value range: 1..63, a value of 0 indicates that this vehicle has been inserted by correction

4.2.2.36 vehId

TRDP_NET_LABEL_T GNU_PACKED::vehId

Unique vehicle identiﬁer, application deﬁned (e.g.

UIC Identiﬁer)

Generated by Doxygen

22 Data Structure Documentation

4.2.2.37 vehOrient

UINT8 GNU_PACKED::vehOrient

vehicle orientation 0 = not known (corrected vehicle) 1 = same as operational train direction 2 = inverse to operational

train direction

vehicle orientation, '00'B = not known (corrected vehicle) '01'B = same as operational train direction '10'B = inverse

to operational train direction

4.2.2.38 version

TRDP_SHORT_VERSION_T GNU_PACKED::version

telegram version information, main_version = 1, sub_version = 0

Train info structure version.

TrainDirectoryState data structure version parameter 'mainVersion' shall be set to 1.

TrainDirectory data structure version parameter 'mainVersion' shall be set to 1.

Consist Info Control structure version parameter 'mainVersion' shall be set to 1.

The documentation for this struct was generated from the following ﬁles:

•tau_ctrl_types.h

•tau_tti_types.h

•trdp_private.h

4.3 PD_ELE Struct Reference

Queue element for PD packets to send or receive.

#include <trdp_private.h>

Collaboration diagram for PD_ELE:

PD_ELE

pNext

TRDP_SESSION

pSndQueue

pRcvQueue

pfCbFunction

pNext TRDP_PD_CONFIG_T

pfCbFunction

pdDefault

TRDP_SEND_PARAM_T sendParam

TRDP_SOCKETS

sendParam

iface

TRDP_SOCKET_TCP tcpParams

TRDP_MEM_CONFIG_T

memConﬁg

TRDP_MARSHALL_CONFIG_T

marshall

TRDP_DATASET

pCachedDS

pfCbUnmarshall

pfCbMarshall

TRDP_DATASET_ELEMENT_T

pCachedDS

pElement

TRDP_STATISTICS_T

stats

TRDP_PD_STATISTICS_T

TRDP_MD_STATISTICS_T

tcpMd

udpMd

TRDP_MEM_STATISTICS_T mem

TRDP_HANDLE addr

Generated by Doxygen

4.3 PD_ELE Struct Reference 23

Data Fields

• struct PD_ELE ∗pNext

pointer to next element or NULL

• UINT32 magic

prevent acces through dangeling pointer

•TRDP_ADDRESSES_T addr

handle of publisher/subscriber

•TRDP_IP_ADDR_T lastSrcIP

last source IP a subscribed packet was received from

•TRDP_IP_ADDR_T pullIpAddress

In case of pulling a PD this is the requested Ip.

• UINT32 redId

Redundancy group ID or zero.

• UINT32 curSeqCnt

the last sent or received sequence counter

• UINT32 curSeqCnt4Pull

the last sent sequence counter for PULL

• TRDP_SEQ_CNT_LIST_T ∗pSeqCntList

pointer to list of received sequence numbers per comId

• UINT32 numRxTx

Counter for received packets (statistics)

• UINT32 updPkts

Counter for updated packets (statistics)

• UINT32 getPkts

Counter for read packets (statistics)

• UINT32 numMissed

Counter for skipped sequence number (statistics)

•TRDP_ERR_T lastErr

Last error (timeout)

• TRDP_PRIV_FLAGS_T privFlags

private ﬂags

• TRDP_FLAGS_T pktFlags

ﬂags

•TRDP_TIME_T interval

time out value for received packets or interval for packets to send (set from ms)

•TRDP_TIME_T timeToGo

next time this packet must be sent/rcv

•TRDP_TO_BEHAVIOR_T toBehavior

timeout behavior for packets

• UINT32 dataSize

net data size

• UINT32 grossSize

complete packet size (header, data)

• UINT32 sendSize

data size sent out

•TRDP_DATASET_T ∗pCachedDS

Pointer to dataset element if known.

• INT32 socketIdx

index into the socket list

• const void ∗pUserRef

Generated by Doxygen

24 Data Structure Documentation

from subscribe()

•TRDP_PD_CALLBACK_T pfCbFunction

Pointer to PD callback function.

• PD_PACKET_T ∗pFrame

header ...

4.3.1 Detailed Description

Queue element for PD packets to send or receive.

4.3.2 Field Documentation

4.3.2.1 pFrame

PD_PACKET_T∗PD_ELE::pFrame

header ...

data + FCS...

The documentation for this struct was generated from the following ﬁle:

•trdp_private.h

4.4 TAU_MARSHALL_INFO_T Struct Reference

Marshalling info, used to and from wire.

Data Fields

• INT32 level

track recursive level

• UINT8 ∗pSrc

source pointer

• UINT8 ∗pSrcEnd

last source

• UINT8 ∗pDst

destination pointer

• UINT8 ∗pDstEnd

last destination

Generated by Doxygen

4.5 TCN_URI Struct Reference 25

4.4.1 Detailed Description

Marshalling info, used to and from wire.

The documentation for this struct was generated from the following ﬁle:

•tau_marshall.c

4.5 TCN_URI Struct Reference

TCN-DNS simpliﬁed header structures.

#include <tau_dnr_types.h>

Data Fields

• CHAR8 tcnUriStr [80]

if != 0 use TCN DNS as resolver

• INT16 resolvState

on request: reserved (= 0), on reply: -1 unknown, 0 OK

• UINT32 tcnUriIpAddr

IP address of URI.

• UINT32 tcnUriIpAddr2

if != 0, end IP address of range

4.5.1 Detailed Description

TCN-DNS simpliﬁed header structures.

The documentation for this struct was generated from the following ﬁle:

•tau_dnr_types.h

4.6 TRDP_CLTR_CST_INFO_T Struct Reference

Closed train consists information.

#include <tau_tti_types.h>

Data Fields

•TRDP_UUID_T cltrCstUUID

closed train consist UUID

• UINT8 cltrCstOrient

closed train consist orientation '01'B = same as closed train direction '10'B = inverse to closed train direction

• UINT8 cltrCstNo

sequence number of the consist within the closed train, value range 1..32

• UINT16 reserved01

reserved for future use (= 0)

Generated by Doxygen

26 Data Structure Documentation

4.6.1 Detailed Description

Closed train consists information.

The documentation for this struct was generated from the following ﬁle:

•tau_tti_types.h

4.7 TRDP_COMID_DSID_MAP_T Struct Reference

ComId - data set mapping element deﬁnition.

#include <trdp_types.h>

Data Fields

• UINT32 comId

comId

• UINT32 datasetId

corresponding dataset Id

4.7.1 Detailed Description

ComId - data set mapping element deﬁnition.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.8 TRDP_CONSIST_INFO_T Struct Reference

consist information structure

#include <tau_tti_types.h>

Collaboration diagram for TRDP_CONSIST_INFO_T:

TRDP_CONSIST_INFO_T

TRDP_FUNCTION_INFO_T

pFctInfoList

TRDP_CLTR_CST_INFO_T pCltrCstInfoList

TRDP_VEHICLE_INFO_T

pVehInfoList

TRDP_PROP_T

cstProp

vehProp

TRDP_ETB_INFO_T

pEtbInfoList

Generated by Doxygen

4.8 TRDP_CONSIST_INFO_T Struct Reference 27

Data Fields

• TRDP_SHORT_VERSION_T version

ConsistInfo data structure version, application deﬁned mainVersion = 1, subVersion = 0.

• UINT8 cstClass

consist info classiﬁcation 1 = (single) consist 2 = closed train 3 = closed train consist

• UINT8 reserved01

reserved for future use (= 0)

•TRDP_NET_LABEL_T cstId

application deﬁned consist identiﬁer, e.g.

•TRDP_NET_LABEL_T cstType

consist type, application deﬁned

•TRDP_NET_LABEL_T cstOwner

consist owner, e.g.

•TRDP_UUID_T cstUUID

consist UUID

• UINT32 reserved02

reserved for future use (= 0)

•TRDP_PROP_T cstProp

static consist properties

• UINT16 reserved03

reserved for future use (= 0)

• UINT16 etbCnt

number of ETB's, range: 1..4

•TRDP_ETB_INFO_T ∗pEtbInfoList

ETB information list for the consist Ordered list starting with lowest etbId.

• UINT16 reserved04

reserved for future use (= 0)

• UINT16 vehCnt

number of vehicles in consist 1..32

•TRDP_VEHICLE_INFO_T ∗pVehInfoList

vehicle info list for the vehicles in the consist Ordered list starting with cstVehNo==1

• UINT16 reserved05

reserved for future use (= 0)

• UINT16 fctCnt

number of consist functions value range 0..1024

•TRDP_FUNCTION_INFO_T ∗pFctInfoList

function info list for the functions in consist lexicographical ordered by fctName

• UINT16 reserved06

reserved for future use (= 0)

• UINT16 cltrCstCnt

number of original consists in closed train value range: 0..32, 0 = consist is no closed train

•TRDP_CLTR_CST_INFO_T ∗pCltrCstInfoList

info on closed train composition Ordered list starting with cltrCstNo == 1

• UINT32 cstTopoCnt

consist topology counter computed as deﬁned in 5.3.3.2.16, seed value: 'FFFFFFFF'H

4.8.1 Detailed Description

consist information structure

Generated by Doxygen

28 Data Structure Documentation

4.8.2 Field Documentation

4.8.2.1 cstId

TRDP_NET_LABEL_T TRDP_CONSIST_INFO_T::cstId

application deﬁned consist identiﬁer, e.g.

UIC identiﬁer

4.8.2.2 cstOwner

TRDP_NET_LABEL_T TRDP_CONSIST_INFO_T::cstOwner

consist owner, e.g.

"trenitalia.it", "sncf.fr", "db.de"

The documentation for this struct was generated from the following ﬁle:

•tau_tti_types.h

4.9 TRDP_DATASET Struct Reference

Dataset deﬁnition.

#include <trdp_types.h>

Collaboration diagram for TRDP_DATASET:

TRDP_DATASET

TRDP_DATASET_ELEMENT_T

pCachedDS pElement

Generated by Doxygen

4.10 TRDP_DATASET_ELEMENT_T Struct Reference 29

Data Fields

• UINT32 id

dataset identiﬁer >1000

• UINT16 reserved1

Reserved for future use, must be zero.

• UINT16 numElement

Number of elements.

•TRDP_DATASET_ELEMENT_T pElement [ ]

Pointer to a dataset element, used as array.

4.9.1 Detailed Description

Dataset deﬁnition.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.10 TRDP_DATASET_ELEMENT_T Struct Reference

Dataset element deﬁnition.

#include <trdp_types.h>

Collaboration diagram for TRDP_DATASET_ELEMENT_T:

TRDP_DATASET_ELEMENT_T

TRDP_DATASET

pElement pCachedDS

Generated by Doxygen

30 Data Structure Documentation

Data Fields

• UINT32 type

Data type (TRDP_DATA_TYPE_T 1...99) or dataset id >1000.

• UINT32 size

Number of items or TRDP_VAR_SIZE (0)

• CHAR8 ∗name

Name param, on special request (Ticket #211)

• CHAR8 ∗unit

Unit text for visualisation.

• REAL32 scale

Factor for visualisation.

• INT32 offset

Offset for visualisation (val = scale ∗x + offset)

• struct TRDP_DATASET ∗pCachedDS

Used internally for marshalling speed-up.

4.10.1 Detailed Description

Dataset element deﬁnition.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.11 TRDP_DBG_CONFIG_T Struct Reference

Control for debug output device/ﬁle on application level.

#include <tau_xml.h>

Data Fields

• TRDP_DBG_OPTION_T option

Debug printout options for application use.

• UINT32 maxFileSize

Maximal ﬁle size.

• TRDP_FILE_NAME_T ﬁleName

Debug ﬁle name and path.

4.11.1 Detailed Description

Control for debug output device/ﬁle on application level.

The documentation for this struct was generated from the following ﬁle:

•tau_xml.h

Generated by Doxygen

4.12 TRDP_DNS_REPLY Struct Reference 31

4.12 TRDP_DNS_REPLY Struct Reference

TCN-DNS Reply telegram TCN_DNS_REP_DS.

#include <tau_dnr_types.h>

Collaboration diagram for TRDP_DNS_REPLY:

TRDP_DNS_REPLY

TCN_URI

tcnUriList

Data Fields

• TRDP_SHORT_VERSION_T version

1.0

•TRDP_NET_LABEL_T deviceName

function device of ED which sends the telegram

• UINT32 etbTopoCnt

ETB topography counter.

• UINT32 opTrnTopoCnt

operational train topography counter needed for TCN-URIs related to the operational train view = 0 if not used

• UINT8 etbId

identiﬁcation of the related ETB 0 = ETB0 (operational network) 1 = ETB1 (multimedia network) 2 = ETB2 (other

network) 3 = ETB3 (other network) 255 = don’t care (for access to local DNS server)

• INT8 dnsStatus

0 = OK -1 = DNS Server not ready -2 = Inauguration in progress

• UINT8 tcnUriCnt

number of TCN-URIs to be resolved value range: 0 .

•TCN_URI_T tcnUriList [255]

deﬁned for max size

• TRDP_ETB_CTRL_VDP_T safetyTrail

SDT trailer.

4.12.1 Detailed Description

TCN-DNS Reply telegram TCN_DNS_REP_DS.

Generated by Doxygen

32 Data Structure Documentation

4.12.2 Field Documentation

4.12.2.1 tcnUriCnt

UINT8 TRDP_DNS_REPLY::tcnUriCnt

number of TCN-URIs to be resolved value range: 0 .

. 255

The documentation for this struct was generated from the following ﬁle:

•tau_dnr_types.h

4.13 TRDP_DNS_REQUEST Struct Reference

TCN-DNS Request telegram TCN_DNS_REQ_DS.

#include <tau_dnr_types.h>

Collaboration diagram for TRDP_DNS_REQUEST:

TRDP_DNS_REQUEST

TCN_URI

tcnUriList

Data Fields

• TRDP_SHORT_VERSION_T version

1.0

•TRDP_NET_LABEL_T deviceName

function device of ED which sends the telegram

• UINT32 etbTopoCnt

ETB topography counter.

• UINT32 opTrnTopoCnt

operational train topography counter needed for TCN-URIs related to the operational train view = 0 if not used

• UINT8 etbId

identiﬁcation of the related ETB 0 = ETB0 (operational network) 1 = ETB1 (multimedia network) 2 = ETB2 (other

network) 3 = ETB3 (other network) 255 = don’t care (for access to local DNS server)

• UINT8 tcnUriCnt

number of TCN-URIs to be resolved value range: 0 .

•TCN_URI_T tcnUriList [255]

deﬁned for max size

• TRDP_ETB_CTRL_VDP_T safetyTrail

SDT trailer.

Generated by Doxygen

4.14 TRDP_ETB_INFO_T Struct Reference 33

4.13.1 Detailed Description

TCN-DNS Request telegram TCN_DNS_REQ_DS.

4.13.2 Field Documentation

4.13.2.1 tcnUriCnt

UINT8 TRDP_DNS_REQUEST::tcnUriCnt

number of TCN-URIs to be resolved value range: 0 .

. 255

The documentation for this struct was generated from the following ﬁle:

•tau_dnr_types.h

4.14 TRDP_ETB_INFO_T Struct Reference

Types for train conﬁguration information.

#include <tau_tti_types.h>

Data Fields

• UINT8 etbId

identiﬁcation of train backbone; value range: 0..3

• UINT8 cnCnt

number of CNs within consist connected to this ETB value range 1..16 referring to cnId 0..15 acc.

• UINT16 reserved01

reserved for future use (= 0)

4.14.1 Detailed Description

Types for train conﬁguration information.

ETB information

4.14.2 Field Documentation

Generated by Doxygen

34 Data Structure Documentation

4.14.2.1 cnCnt

UINT8 TRDP_ETB_INFO_T::cnCnt

number of CNs within consist connected to this ETB value range 1..16 referring to cnId 0..15 acc.

IEC61375-2-5

The documentation for this struct was generated from the following ﬁle:

•tau_tti_types.h

4.15 TRDP_FUNCTION_INFO_T Struct Reference

function/device information structure

#include <tau_tti_types.h>

Data Fields

•TRDP_NET_LABEL_T fctName

function device or group label

• UINT16 fctId

host identiﬁcation of the function device or group as deﬁned in IEC 61375-2-5, application deﬁned.

• BOOL8 grp

is a function group and will be resolved as IP multicast address

• UINT8 reserved01

reserved for future use (= 0)

• UINT8 cstVehNo

Sequence number of the vehicle in the consist the function belongs to.

• UINT8 etbId

number of connected train backbone.

• UINT8 cnId

identiﬁer of connected consist network in the consist, related to the etbId.

• UINT8 reserved02

reserved for future use (= 0)

4.15.1 Detailed Description

function/device information structure

4.15.2 Field Documentation

Generated by Doxygen

4.16 TRDP_HANDLE Struct Reference 35

4.15.2.1 cnId

UINT8 TRDP_FUNCTION_INFO_T::cnId

identiﬁer of connected consist network in the consist, related to the etbId.

Value range: 0..31

4.15.2.2 cstVehNo

UINT8 TRDP_FUNCTION_INFO_T::cstVehNo

Sequence number of the vehicle in the consist the function belongs to.

Value range: 1..16, 0 = not deﬁned

4.15.2.3 etbId

UINT8 TRDP_FUNCTION_INFO_T::etbId

number of connected train backbone.

Value range: 0..3

4.15.2.4 fctId

UINT16 TRDP_FUNCTION_INFO_T::fctId

host identiﬁcation of the function device or group as deﬁned in IEC 61375-2-5, application deﬁned.

Value range: 1..16383 (device), 256..16383 (group)

The documentation for this struct was generated from the following ﬁle:

•tau_tti_types.h

4.16 TRDP_HANDLE Struct Reference

Hidden handle deﬁnition, used as unique addressing item.

#include <trdp_private.h>

Generated by Doxygen

36 Data Structure Documentation

Data Fields

• UINT32 comId

comId for packets to send/receive

•TRDP_IP_ADDR_T srcIpAddr

source IP for PD/MD

•TRDP_IP_ADDR_T srcIpAddr2

second source IP for PD/MD

•TRDP_IP_ADDR_T destIpAddr

destination IP for PD

•TRDP_IP_ADDR_T mcGroup

multicast group to join for PD

• UINT32 etbTopoCnt

etb topocount belongs to addressing item

• UINT32 opTrnTopoCnt

opTrn topocount belongs to addressing item

4.16.1 Detailed Description

Hidden handle deﬁnition, used as unique addressing item.

The documentation for this struct was generated from the following ﬁle:

•trdp_private.h

4.17 TRDP_LIST_STATISTICS_T Struct Reference

Information about a particular MD listener.

#include <trdp_types.h>

Data Fields

• UINT32 comId

ComId to listen to.

• TRDP_URI_USER_T uri

URI user part to listen to.

•TRDP_IP_ADDR_T joinedAddr

Joined IP address.

• UINT32 callBack

Call back function if used.

• UINT32 userRef

User reference if used.

• UINT32 numSessions

Number of sessions.

Generated by Doxygen

4.18 TRDP_MARSHALL_CONFIG_T Struct Reference 37

4.17.1 Detailed Description

Information about a particular MD listener.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.18 TRDP_MARSHALL_CONFIG_T Struct Reference

Marshaling/unmarshalling conﬁguration.

#include <trdp_types.h>

Collaboration diagram for TRDP_MARSHALL_CONFIG_T:

TRDP_MARSHALL_CONFIG_T

TRDP_DATASET

pfCbUnmarshall

pfCbMarshall

TRDP_DATASET_ELEMENT_T

pCachedDS pElement

Data Fields

•TRDP_MARSHALL_T pfCbMarshall

Pointer to marshall callback function.

•TRDP_UNMARSHALL_T pfCbUnmarshall

Pointer to unmarshall callback function.

• void ∗pRefCon

Pointer to user context for call back.

4.18.1 Detailed Description

Marshaling/unmarshalling conﬁguration.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

Generated by Doxygen

38 Data Structure Documentation

4.19 TRDP_MD_CONFIG_T Struct Reference

Default MD conﬁguration.

#include <trdp_types.h>

Collaboration diagram for TRDP_MD_CONFIG_T:

TRDP_MD_CONFIG_T

TRDP_SESSION

pfCbFunction

pNext

TRDP_PD_CONFIG_T pfCbFunction

PD_ELE

pfCbFunction

pdDefault

TRDP_SEND_PARAM_T sendParam

sendParam

TRDP_SOCKETS

sendParam

pSndQueue

pRcvQueue

pNext

TRDP_HANDLE addr

TRDP_DATASET pCachedDS

TRDP_DATASET_ELEMENT_T

pCachedDS

TRDP_MARSHALL_CONFIG_T

pfCbUnmarshall

pfCbMarshall

pElement

iface

TRDP_SOCKET_TCP tcpParams

TRDP_MEM_CONFIG_T

memConﬁg

marshall

TRDP_STATISTICS_T stats

TRDP_PD_STATISTICS_T

TRDP_MD_STATISTICS_T

tcpMd

udpMd

TRDP_MEM_STATISTICS_T

mem

Data Fields

•TRDP_MD_CALLBACK_T pfCbFunction

Pointer to MD callback function.

• void ∗pRefCon

Pointer to user context for call back.

•TRDP_SEND_PARAM_T sendParam

Default send parameters.

• TRDP_FLAGS_T ﬂags

Default ﬂags for MD packets.

• UINT32 replyTimeout

Default reply timeout in us.

• UINT32 conﬁrmTimeout

Default conﬁrmation timeout in us.

• UINT32 connectTimeout

Default connection timeout in us.

• UINT32 sendingTimeout

Default sending timeout in us.

• UINT16 udpPort

Port to be used for UDP MD communication.

• UINT16 tcpPort

Port to be used for TCP MD communication.

• UINT32 maxNumSessions

Maximal number of replier sessions.

Generated by Doxygen

4.20 TRDP_MD_INFO_T Struct Reference 39

4.19.1 Detailed Description

Default MD conﬁguration.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.20 TRDP_MD_INFO_T Struct Reference

Message data info from received telegram; allows the application to generate responses.

#include <trdp_types.h>

Data Fields

•TRDP_IP_ADDR_T srcIpAddr

source IP address for ﬁltering

•TRDP_IP_ADDR_T destIpAddr

destination IP address for ﬁltering

• UINT32 seqCount

sequence counter

• UINT16 protVersion

Protocol version.

• TRDP_MSG_T msgType

Protocol ('PD', 'MD', ...)

• UINT32 comId

ComID.

• UINT32 etbTopoCnt

received topocount

• UINT32 opTrnTopoCnt

received topocount

• BOOL8 aboutToDie

session is about to die

• UINT32 numRepliesQuery

number of ReplyQuery received

• UINT32 numConﬁrmSent

number of Conﬁrm sent

• UINT32 numConﬁrmTimeout

number of Conﬁrm Timeouts (incremented by listeners

• UINT16 userStatus

error code, user stat

•TRDP_REPLY_STATUS_T replyStatus

reply status

•TRDP_UUID_T sessionId

for response

• UINT32 replyTimeout

reply timeout in us given with the request

Generated by Doxygen

40 Data Structure Documentation

• TRDP_URI_USER_T srcUserURI

source URI user part from MD header

• TRDP_URI_HOST_T srcHostURI

source URI host part (unused)

• TRDP_URI_USER_T destUserURI

destination URI user part from MD header

• TRDP_URI_HOST_T destHostURI

destination URI host part (unused)

• UINT32 numExpReplies

number of expected replies, 0 if unknown

• UINT32 numReplies

actual number of replies for the request

• const void ∗pUserRef

User reference given with the local call.

•TRDP_ERR_T resultCode

error code

4.20.1 Detailed Description

Message data info from received telegram; allows the application to generate responses.

Note: Not all ﬁelds are relevant for each message type!

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.21 TRDP_MD_STATISTICS_T Struct Reference

Structure containing all general MD statistics information.

#include <trdp_types.h>

Data Fields

• UINT32 defQos

default QoS for MD

• UINT32 defTtl

default TTL for MD

• UINT32 defReplyTimeout

default reply timeout in us for MD

• UINT32 defConﬁrmTimeout

default conﬁrm timeout in us for MD

• UINT32 numList

number of listeners

• UINT32 numRcv

number of received MD packets

• UINT32 numCrcErr

Generated by Doxygen

4.22 TRDP_MEM_CONFIG_T Struct Reference 41

number of received MD packets with CRC err

• UINT32 numProtErr

number of received MD packets with protocol err

• UINT32 numTopoErr

number of received MD packets with wrong topo count

• UINT32 numNoListener

number of received MD packets without listener

• UINT32 numReplyTimeout

number of reply timeouts

• UINT32 numConﬁrmTimeout

number of conﬁrm timeouts

• UINT32 numSend

number of sent MD packets

4.21.1 Detailed Description

Structure containing all general MD statistics information.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.22 TRDP_MEM_CONFIG_T Struct Reference

Enumeration type for memory pre-fragmentation, reuse of VOS deﬁnition.

#include <trdp_types.h>

Data Fields

• UINT8 ∗p

pointer to static or allocated memory

• UINT32 size

size of static or allocated memory

• UINT32 prealloc [VOS_MEM_NBLOCKSIZES]

memory block structure

4.22.1 Detailed Description

Enumeration type for memory pre-fragmentation, reuse of VOS deﬁnition.

Structure describing memory (and its pre-fragmentation)

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

Generated by Doxygen

42 Data Structure Documentation

4.23 TRDP_MEM_STATISTICS_T Struct Reference

Structure containing all general memory statistics information.

#include <trdp_types.h>

Data Fields

• UINT32 total

total memory size

• UINT32 free

free memory size

• UINT32 minFree

minimal free memory size in statistics interval

• UINT32 numAllocBlocks

allocated memory blocks

• UINT32 numAllocErr

allocation errors

• UINT32 numFreeErr

free errors

• UINT32 blockSize [VOS_MEM_NBLOCKSIZES]

preallocated memory blocks

• UINT32 usedBlockSize [VOS_MEM_NBLOCKSIZES]

used memory blocks

4.23.1 Detailed Description

Structure containing all general memory statistics information.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.24 TRDP_PD_CONFIG_T Struct Reference

Default PD conﬁguration.

#include <trdp_types.h>

Collaboration diagram for TRDP_PD_CONFIG_T:

TRDP_PD_CONFIG_T TRDP_SESSION

pdDefault

pfCbFunction

pNext

PD_ELE

pfCbFunction

pSndQueue

pRcvQueue

pNext

TRDP_HANDLE addr

TRDP_DATASET

pCachedDS

TRDP_DATASET_ELEMENT_T

pCachedDS

TRDP_MARSHALL_CONFIG_T

pfCbUnmarshall

pfCbMarshall

pElement

TRDP_SOCKETS

iface

TRDP_SEND_PARAM_T

sendParam

TRDP_SOCKET_TCP tcpParams

TRDP_MEM_CONFIG_T

memConﬁg

marshall

TRDP_STATISTICS_T

stats

TRDP_PD_STATISTICS_T pd

TRDP_MD_STATISTICS_T

tcpMd

udpMd

TRDP_MEM_STATISTICS_T

mem

Generated by Doxygen

4.25 TRDP_PD_INFO_T Struct Reference 43

Data Fields

•TRDP_PD_CALLBACK_T pfCbFunction

Pointer to PD callback function.

• void ∗pRefCon

Pointer to user context for call back.

•TRDP_SEND_PARAM_T sendParam

Default send parameters.

• TRDP_FLAGS_T ﬂags

Default ﬂags for PD packets.

• UINT32 timeout

Default timeout in us.

•TRDP_TO_BEHAVIOR_T toBehavior

Default timeout behavior.

• UINT16 port

Port to be used for PD communication.

4.24.1 Detailed Description

Default PD conﬁguration.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.25 TRDP_PD_INFO_T Struct Reference

Process data info from received telegram; allows the application to generate responses.

#include <trdp_types.h>

Data Fields

•TRDP_IP_ADDR_T srcIpAddr

source IP address for ﬁltering

•TRDP_IP_ADDR_T destIpAddr

destination IP address for ﬁltering

• UINT32 seqCount

sequence counter

• UINT16 protVersion

Protocol version.

• TRDP_MSG_T msgType

Protocol ('PD', 'MD', ...)

• UINT32 comId

ComID.

• UINT32 etbTopoCnt

received ETB topocount

• UINT32 opTrnTopoCnt

Generated by Doxygen

44 Data Structure Documentation

received operational train directory topocount

• UINT32 replyComId

ComID for reply (request only)

•TRDP_IP_ADDR_T replyIpAddr

IP address for reply (request only)

• const void ∗pUserRef

User reference given with the local subscribe.

•TRDP_ERR_T resultCode

error code

• TRDP_URI_HOST_T srcHostURI

source URI host part (unused)

• TRDP_URI_HOST_T destHostURI

destination URI host part (unused)

•TRDP_TO_BEHAVIOR_T toBehavior

callback can decide about handling of data on timeout

4.25.1 Detailed Description

Process data info from received telegram; allows the application to generate responses.

Note: Not all ﬁelds are relevant for each message type!

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.26 TRDP_PD_STATISTICS_T Struct Reference

Structure containing all general PD statistics information.

#include <trdp_types.h>

Data Fields

• UINT32 defQos

default QoS for PD

• UINT32 defTtl

default TTL for PD

• UINT32 defTimeout

default timeout in us for PD

• UINT32 numSubs

number of subscribed ComId's

• UINT32 numPub

number of published ComId's

• UINT32 numRcv

number of received PD packets

• UINT32 numCrcErr

number of received PD packets with CRC err

Generated by Doxygen

4.27 TRDP_PROCESS_CONFIG_T Struct Reference 45

• UINT32 numProtErr

number of received PD packets with protocol err

• UINT32 numTopoErr

number of received PD packets with wrong topo count

• UINT32 numNoSubs

number of received PD push packets without subscription

• UINT32 numNoPub

number of received PD pull packets without publisher

• UINT32 numTimeout

number of PD timeouts

• UINT32 numSend

number of sent PD packets

• UINT32 numMissed

number of packets skipped

4.26.1 Detailed Description

Structure containing all general PD statistics information.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.27 TRDP_PROCESS_CONFIG_T Struct Reference

Various ﬂags/general TRDP options for library initialization.

#include <trdp_types.h>

Data Fields

• TRDP_LABEL_T hostName

Host name.

• TRDP_LABEL_T leaderName

Leader name dependant on redundancy concept.

• UINT32 cycleTime

TRDP main process cycle time in us.

• UINT32 priority

TRDP main process priority (0-255, 0=default, 255=highest)

• TRDP_OPTION_T options

TRDP options.

4.27.1 Detailed Description

Various ﬂags/general TRDP options for library initialization.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

Generated by Doxygen

46 Data Structure Documentation

4.28 TRDP_PROP_T Struct Reference

Application deﬁned properties.

#include <tau_tti_types.h>

Data Fields

• TRDP_SHORT_VERSION_T ver

properties version information, application deﬁned

• UINT16 len

properties length in number of octets, application deﬁned, must be a multiple of 4 octets for alignment reasons value

range: 0..32768

• UINT8 prop [1]

properties, application deﬁned

4.28.1 Detailed Description

Application deﬁned properties.

The documentation for this struct was generated from the following ﬁle:

•tau_tti_types.h

4.29 TRDP_PUB_STATISTICS_T Struct Reference

Table containing particular PD publishing information.

#include <trdp_types.h>

Data Fields

• UINT32 comId

Published ComId.

•TRDP_IP_ADDR_T destAddr

IP address of destination for this publishing.

• UINT32 cycle

Publishing cycle in us.

• UINT32 redId

Redundancy group id.

• UINT32 redState

Redundant state.Leader or Follower.

• UINT32 numPut

Number of packet updates.

• UINT32 numSend

Number of packets sent out.

Generated by Doxygen

4.30 TRDP_RED_STATISTICS_T Struct Reference 47

4.29.1 Detailed Description

Table containing particular PD publishing information.

4.29.2 Field Documentation

4.29.2.1 destAddr

TRDP_IP_ADDR_T TRDP_PUB_STATISTICS_T::destAddr

IP address of destination for this publishing.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.30 TRDP_RED_STATISTICS_T Struct Reference

A table containing PD redundant group information.

#include <trdp_types.h>

Data Fields

• UINT32 id

Redundant Id.

• UINT32 state

Redundant state.Leader or Follower.

4.30.1 Detailed Description

A table containing PD redundant group information.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.31 TRDP_SDT_PAR_T Struct Reference

Types to read out the XML conﬁguration.

#include <tau_xml.h>

Generated by Doxygen

48 Data Structure Documentation

Data Fields

• UINT32 smi1

Safe message identiﬁer - unique for this message at consist level.

• UINT32 smi2

Safe message identiﬁer - unique for this message at consist level.

• UINT32 cmThr

Channel monitoring threshold.

• UINT16 udv

User data version.

• UINT16 rxPeriod

Sink cycle time.

• UINT16 txPeriod

Source cycle time.

• UINT16 nGuard

Initial timeout cycles.

• UINT8 nrxSafe

Timout cycles.

• UINT8 reserved1

Reserved for future use.

• UINT16 reserved2

Reserved for future use.

4.31.1 Detailed Description

Types to read out the XML conﬁguration.

The documentation for this struct was generated from the following ﬁle:

•tau_xml.h

4.32 TRDP_SEND_PARAM_T Struct Reference

Quality/type of service and time to live.

#include <trdp_types.h>

Data Fields

• UINT8 qos

Quality of service (default should be 5 for PD and 3 for MD)

• UINT8 ttl

Time to live (default should be 64)

• UINT8 retries

Retries from XML ﬁle.

Generated by Doxygen

4.33 TRDP_SEQ_CNT_ENTRY_T Struct Reference 49

4.32.1 Detailed Description

Quality/type of service and time to live.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.33 TRDP_SEQ_CNT_ENTRY_T Struct Reference

Tuples of last received sequence counter per comId.

#include <trdp_private.h>

Data Fields

• UINT32 lastSeqCnt

Sequence counter value for comId.

•TRDP_IP_ADDR_T srcIpAddr

Source IP address.

• TRDP_MSG_T msgType

message type

4.33.1 Detailed Description

Tuples of last received sequence counter per comId.

The documentation for this struct was generated from the following ﬁle:

•trdp_private.h

4.34 TRDP_SESSION Struct Reference

Session/application variables store.

#include <trdp_private.h>

Collaboration diagram for TRDP_SESSION:

TRDP_SESSION

pNext

TRDP_PD_CONFIG_T

pfCbFunction

PD_ELE

pfCbFunction

pdDefault

TRDP_SEND_PARAM_T sendParam

TRDP_SOCKETS

sendParam

pSndQueue

pRcvQueue

pNext

TRDP_HANDLE addr

TRDP_DATASET

pCachedDS

TRDP_DATASET_ELEMENT_T

pCachedDS

TRDP_MARSHALL_CONFIG_T

pfCbUnmarshall

pfCbMarshall

pElement

iface

TRDP_SOCKET_TCP tcpParams

TRDP_MEM_CONFIG_T memConﬁg

marshall

TRDP_STATISTICS_T

stats

TRDP_PD_STATISTICS_T pd

TRDP_MD_STATISTICS_T

tcpMd

udpMd

TRDP_MEM_STATISTICS_T mem

Generated by Doxygen

50 Data Structure Documentation

Data Fields

• struct TRDP_SESSION ∗pNext

Pointer to next session.

•VOS_MUTEX_T mutex

protect this session

•TRDP_IP_ADDR_T realIP

Real IP address.

•TRDP_IP_ADDR_T virtualIP

Virtual IP address.

• UINT32 etbTopoCnt

current valid topocount or zero

• UINT32 opTrnTopoCnt

current valid topocount or zero

•TRDP_TIME_T nextJob

Store for next select interval.

•TRDP_PRINT_DBG_T pPrintDebugString

Pointer to function to print debug information.

•TRDP_MARSHALL_CONFIG_T marshall

Marshalling(unMarshalling conﬁguration.

•TRDP_PD_CONFIG_T pdDefault

Default conﬁguration for process data.

•TRDP_MEM_CONFIG_T memConﬁg

Internal memory handling conﬁguration.

• TRDP_OPTION_T option

Stack behavior options.

•TRDP_SOCKETS_T iface [VOS_MAX_SOCKET_CNT]

Collection of sockets to use.

•PD_ELE_T ∗pSndQueue

pointer to ﬁrst element of send queue

•PD_ELE_T ∗pRcvQueue

pointer to ﬁrst element of rcv queue

• PD_PACKET_T ∗pNewFrame

pointer to received PD frame

•TRDP_TIME_T initTime

initialization time of session

•TRDP_STATISTICS_T stats

statistics of this session

4.34.1 Detailed Description

Session/application variables store.

The documentation for this struct was generated from the following ﬁle:

•trdp_private.h

Generated by Doxygen

4.35 TRDP_SOCKET_TCP Struct Reference 51

4.35 TRDP_SOCKET_TCP Struct Reference

TCP parameters.

#include <trdp_private.h>

Data Fields

•TRDP_IP_ADDR_T cornerIp

The other TCP corner Ip.

• BOOL8 notSend

If the message has been sent uncompleted.

•TRDP_TIME_T connectionTimeout

TCP socket connection Timeout.

• BOOL8 sendNotOk

The sending timeout will be start.

•TRDP_TIME_T sendingTimeout

The timeout sending the message.

• BOOL8 addFileDesc

Ready to add the socket in the fd.

• BOOL8 morituri

about to die

4.35.1 Detailed Description

TCP parameters.

The documentation for this struct was generated from the following ﬁle:

•trdp_private.h

4.36 TRDP_SOCKETS Struct Reference

Socket item.

#include <trdp_private.h>

Collaboration diagram for TRDP_SOCKETS:

TRDP_SOCKETS

TRDP_SEND_PARAM_T

sendParam

TRDP_SOCKET_TCP

tcpParams

Generated by Doxygen

52 Data Structure Documentation

Data Fields

• SOCKET sock

vos socket descriptor to use

•TRDP_IP_ADDR_T bindAddr

Deﬁnes the interface to use.

•TRDP_SEND_PARAM_T sendParam

Send parameters.

•TRDP_SOCK_TYPE_T type

Usage of this socket.

• BOOL8 rcvMostly

Used for receiving.

• INT16 usage

No.

•TRDP_SOCKET_TCP_T tcpParams

Params used for TCP.

•TRDP_IP_ADDR_T mcGroups [VOS_MAX_MULTICAST_CNT]

List of multicast addresses for this socket.

4.36.1 Detailed Description

Socket item.

4.36.2 Field Documentation

4.36.2.1 usage

INT16 TRDP_SOCKETS::usage

No.

of current users of this socket

The documentation for this struct was generated from the following ﬁle:

•trdp_private.h

4.37 TRDP_STATISTICS_REQUEST_T Struct Reference

TRDP statistics type deﬁnitions.

#include <trdp_types.h>

Generated by Doxygen

4.38 TRDP_STATISTICS_T Struct Reference 53

Data Fields

• UINT32 comId

ComId to request: 35...41.

4.37.1 Detailed Description

TRDP statistics type deﬁnitions.

Statistical data regarding the former info provided via SNMP the following information was left out/can be imple-

mented additionally using MD:

• PD subscr table: ComId, sourceIpAddr, destIpAddr, cbFct?, timout, toBehavior, counter

• PD publish table: ComId, destIpAddr, redId, redState cycle, ttl, qos, counter

• PD join table: joined MC address table

• MD listener table: ComId destIpAddr, destUri, cbFct?, counter

• Memory usageStructure containing comId for MD statistics request (ComId 32).

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.38 TRDP_STATISTICS_T Struct Reference

Structure containing all general memory, PD and MD statistics information.

#include <trdp_types.h>

Collaboration diagram for TRDP_STATISTICS_T:

TRDP_STATISTICS_T

TRDP_PD_STATISTICS_T

TRDP_MD_STATISTICS_T

tcpMd

udpMd

TRDP_MEM_STATISTICS_T

mem

Generated by Doxygen

54 Data Structure Documentation

Data Fields

• UINT32 version

TRDP version.

• TIMEDATE64 timeStamp

actual time stamp

• TIMEDATE32 upTime

time in sec since last initialisation

• TIMEDATE32 statisticTime

time in sec since last reset of statistics

•TRDP_NET_LABEL_T hostName

host name

•TRDP_NET_LABEL_T leaderName

leader host name

•TRDP_IP_ADDR_T ownIpAddr

own IP address

•TRDP_IP_ADDR_T leaderIpAddr

leader IP address

• UINT32 processPrio

priority of TRDP process

• UINT32 processCycle

cycle time of TRDP process in microseconds

• UINT32 numJoin

number of joins

• UINT32 numRed

number of redundancy groups

•TRDP_MEM_STATISTICS_T mem

memory statistics

•TRDP_PD_STATISTICS_T pd

pd statistics

•TRDP_MD_STATISTICS_T udpMd

UDP md statistics.

•TRDP_MD_STATISTICS_T tcpMd

TCP md statistics.

4.38.1 Detailed Description

Structure containing all general memory, PD and MD statistics information.

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.39 TRDP_SUBS_STATISTICS_T Struct Reference

Table containing particular PD subscription information.

#include <trdp_types.h>

Generated by Doxygen

4.39 TRDP_SUBS_STATISTICS_T Struct Reference 55

Data Fields

• UINT32 comId

Subscribed ComId.

•TRDP_IP_ADDR_T joinedAddr

Joined IP address.

•TRDP_IP_ADDR_T ﬁlterAddr

Filter IP address, i.e IP address of the sender for this subscription, 0.0.0.0 in case all senders.

• UINT32 callBack

call back function if used

• UINT32 userRef

User reference if used.

• UINT32 timeout

Time-out value in us.

•TRDP_ERR_T status

Receive status information TRDP_NO_ERR, TRDP_TIMEOUT_ERR.

• UINT32 toBehav

Behavior at time-out.

• UINT32 numRecv

Number of packets received for this subscription.

• UINT32 numMissed

number of packets skipped for this subscription

4.39.1 Detailed Description

Table containing particular PD subscription information.

4.39.2 Field Documentation

4.39.2.1 ﬁlterAddr

TRDP_IP_ADDR_T TRDP_SUBS_STATISTICS_T::filterAddr

Filter IP address, i.e IP address of the sender for this subscription, 0.0.0.0 in case all senders.

4.39.2.2 timeout

UINT32 TRDP_SUBS_STATISTICS_T::timeout

Time-out value in us.

0 = No time-out supervision

Generated by Doxygen

56 Data Structure Documentation

4.39.2.3 toBehav

UINT32 TRDP_SUBS_STATISTICS_T::toBehav

Behavior at time-out.

Set data to zero / keep last value

The documentation for this struct was generated from the following ﬁle:

•trdp_types.h

4.40 TRDP_VEHICLE_INFO_T Struct Reference

vehicle information structure

#include <tau_tti_types.h>

Collaboration diagram for TRDP_VEHICLE_INFO_T:

TRDP_VEHICLE_INFO_T

TRDP_PROP_T

vehProp

Data Fields

•TRDP_NET_LABEL_T vehId

vehicle identiﬁer label,application deﬁned (e.g.

•TRDP_NET_LABEL_T vehType

vehicle type,application deﬁned

• UINT8 vehOrient

vehicle orientation '01'B = same as consist direction '10'B = inverse to consist direction

• UINT8 cstVehNo

Sequence number of vehicle in consist(1..16)

• ANTIVALENT8 tractVeh

vehicle is a traction vehicle '01'B = vehicle is not a traction vehicle '10'B = vehicle is a traction vehicle

• UINT8 reserved01

for future use (= 0)

•TRDP_PROP_T vehProp

static vehicle properties

Generated by Doxygen

4.41 TRDP_XML_DOC_HANDLE_T Struct Reference 57

4.40.1 Detailed Description

vehicle information structure

4.40.2 Field Documentation

4.40.2.1 vehId

TRDP_NET_LABEL_T TRDP_VEHICLE_INFO_T::vehId

vehicle identiﬁer label,application deﬁned (e.g.

UIC vehicle identiﬁcation number) vehId of vehicle with vehNo==1 is used also as cstId

The documentation for this struct was generated from the following ﬁle:

•tau_tti_types.h

4.41 TRDP_XML_DOC_HANDLE_T Struct Reference

Parsed XML document handle.

#include <tau_xml.h>

Data Fields

• struct XML_HANDLE ∗pXmlDocument

XML document context.

4.41.1 Detailed Description

Parsed XML document handle.

The documentation for this struct was generated from the following ﬁle:

•tau_xml.h

4.42 VOS_SOCK_OPT_T Struct Reference

Common socket options.

#include <vos_sock.h>

Generated by Doxygen

58 Data Structure Documentation

Data Fields

• UINT8 qos

quality/type of service 0...7

• UINT8 ttl

time to live for unicast (default 64)

• UINT8 ttl_multicast

time to live for multicast

• BOOL8 reuseAddrPort

allow reuse of address and port

• BOOL8 nonBlocking

use non blocking calls

• BOOL8 no_mc_loop

no multicast loop back

• BOOL8 no_udp_crc

supress udp crc computation

4.42.1 Detailed Description

Common socket options.

The documentation for this struct was generated from the following ﬁle:

•vos_sock.h

4.43 VOS_VERSION_T Struct Reference

Version information.

#include <vos_types.h>

Data Fields

• UINT8 ver

Version - incremented for incompatible changes.

• UINT8 rel

Release - incremented for compatible changes.

• UINT8 upd

Update - incremented for bug ﬁxes.

• UINT8 evo

Evolution - incremented for build.

4.43.1 Detailed Description

Version information.

The documentation for this struct was generated from the following ﬁle:

•vos_types.h

Generated by Doxygen

Chapter 5

File Documentation

5.1 iec61375-2-3.h File Reference

All deﬁnitions from IEC 61375-2-3.

This graph shows which ﬁles directly or indirectly include this ﬁle:

iec61375-2-3.h

trdp_types.h

tau_ctrl.h

tau_ctrl.c

tau_tti.h

tau_ctrl_types.h

tau_tti_types.h

tau_dnr.h

tau_dnr_types.h

tau_marshall.h

tau_marshall.c

tau_xml.h

tau_xml.c

trdp_if_light.h

trdp_pdcom.c

trdp_private.h

tau_cstinfo.c

tau_tti.c

tau_dnr.c trdp_if.c

trdp_stats.h

trdp_stats.c

trdp_if.h

trdp_mdcom.c trdp_utils.c

trdp_utils.h trdp_xml.htrdp_pdcom.htrdp_mdcom.h

trdp_xml.c

Macros

• #deﬁne ETB_WAIT_TIMER_VALUE 5u /∗Compute train dir. IEC61375-2-3 Ch. 5.3.2.3 ∗/

Time out values (in seconds)

• #deﬁne TRDP_PD_UDP_PORT 17224u

TRDP deﬁnes (from former trpd_proto.h)

• #deﬁne TRDP_MD_UDP_PORT 17225u

IANA assigned message data UDP port.

• #deﬁne TRDP_MD_TCP_PORT 17225u

IANA assigned message data TCP port.

• #deﬁne TRDP_PROTO_VER 0x0100u

Protocol version.

• #deﬁne TRDP_PROTOCOL_VERSION_CHECK_MASK 0xFF00u

Version check, two digits are relevant.

• #deﬁne TRDP_SESS_ID_SIZE 16u

Session ID (UUID) size in MD header.

• #deﬁne TRDP_USR_URI_SIZE 32u

max.

• #deﬁne TRDP_MD_INFINITE_TIME (0)

60 File Documentation

Deﬁnitions for time out behaviour accd.

• #deﬁne TRDP_MD_DEFAULT_REPLY_TIMEOUT 5000000u

Default MD communication parameters.

• #deﬁne TRDP_MD_DEFAULT_CONFIRM_TIMEOUT 1000000u

[us] default conﬁrm time out 1s

• #deﬁne TRDP_MD_DEFAULT_CONNECTION_TIMEOUT 60000000u

[us] Socket connection time out 1min

• #deﬁne TRDP_MD_DEFAULT_SENDING_TIMEOUT 5000000u

[us] Socket sending time out 5s

• #deﬁne TRDP_PD_DEFAULT_QOS 5u

Default PD communication parameters.

• #deﬁne TRDP_PD_DEFAULT_TIMEOUT 100000u

[us] 100ms default PD timeout

• #deﬁne TRDP_PROCESS_DEFAULT_CYCLE_TIME 10000u

Default TRDP process options.

• #deﬁne TRDP_PROCESS_DEFAULT_PRIORITY 64u

Default priority of TRDP process.

• #deﬁne TRDP_PROCESS_DEFAULT_OPTIONS TRDP_OPTION_TRAFFIC_SHAPING

Default options for TRDP process.

• #deﬁne TRDP_MIN_PD_HEADER_SIZE sizeof(PD_HEADER_T)

PD packet properties.

• #deﬁne TRDP_MAX_PD_DATA_SIZE 1432u

PD data.

• #deﬁne TRDP_MAX_MD_DATA_SIZE 65388u

MD packet properties.

• #deﬁne TRDP_MAX_MD_RETRIES 2u

Maximum values.

• #deﬁne TRDP_MAX_LABEL_LEN 16u

label length incl.

• #deﬁne TRDP_MAX_URI_USER_LEN (2u ∗TRDP_MAX_LABEL_LEN)

URI user part excl.

• #deﬁne TRDP_MAX_URI_HOST_LEN (4u ∗TRDP_MAX_LABEL_LEN)

URI host part length excl.

• #deﬁne TRDP_MAX_URI_LEN ((6u ∗TRDP_MAX_LABEL_LEN) + 8u)

URI length excl.

• #deﬁne TRDP_MAX_FILE_NAME_LEN 128u

path and ﬁle name length incl.

• #deﬁne TRDP_VAR_SIZE 0u

Variable size dataset.

• #deﬁne TRDP_MSG_PD 0x5064u

Message Types.

• #deﬁne TRDP_MSG_PP 0x5070u

'Pp' PD Data (Pull Reply)

• #deﬁne TRDP_MSG_PR 0x5072u

'Pr' PD Request

• #deﬁne TRDP_MSG_PE 0x5065u

'Pe' PD Error

• #deﬁne TRDP_MSG_MN 0x4D6Eu

'Mn' MD Notiﬁcation (Request w/o reply)

• #deﬁne TRDP_MSG_MR 0x4D72u

'Mr' MD Request with reply

Generated by Doxygen

5.1 iec61375-2-3.h File Reference 61

• #deﬁne TRDP_MSG_MP 0x4D70u

'Mp' MD Reply without conﬁrmation

• #deﬁne TRDP_MSG_MQ 0x4D71u

'Mq' MD Reply with conﬁrmation

• #deﬁne TRDP_MSG_MC 0x4D63u

'Mc' MD Conﬁrm

• #deﬁne TRDP_MSG_ME 0x4D65u

'Me' MD Error

• #deﬁne ETB0_ALL_END_DEVICES_IP "239.193.0.0"

from Table 22

• #deﬁne ETB_CTRL_COMID 1u

Reserved COMIDs in the range 1 ...

• #deﬁne ETB_CTRL_CYC 500u

[ms] 0.5s

• #deﬁne ETB_CTRL_TO 3000u

[ms]3s

• #deﬁne TRDP_ETBCTRL_COMID ETB_CTRL_COMID

alternative name

• #deﬁne CSTINFO_COMID 2u

Consist Info telegram (Message data notiﬁcation 'Mn')

• #deﬁne TRDP_CSTINFO_COMID CSTINFO_COMID

alternative name

• #deﬁne CSTINFOCTRL_COMID 3u

Consist Info control/request telegram (Message data notiﬁcation 'Mn')

• #deﬁne TRDP_CSTINFOCTRL_COMID CSTINFOCTRL_COMID

alternative name

• #deﬁne TRDP_COMID_ECHO 10u

Reserved in Annex D & E.

• #deﬁne TTDB_STATUS_COMID 100u

TTDB manager telegram PD.

• #deﬁne TTDB_STATUS_CYC 1000u

[ms] Push

• #deﬁne TTDB_STATUS_TO 5000u

[ms] 5s

• #deﬁne TTDB_OP_DIR_INFO_COMID 101u

TTDB manager telegram MD: Push the OP_TRAIN_DIRECTORY.

• #deﬁne TTDB_OP_DIR_INFO_DS "TTDB_OP_TRAIN_DIRECTORY_INFO"

OP_TRAIN_DIRECTORY.

• #deﬁne TTDB_TRN_DIR_REQ_COMID 102u

TTDB manager telegram MD: Get the TRAIN_DIRECTORY.

• #deﬁne TTDB_TRN_DIR_REQ_TO 3000u

3s timeout

• #deﬁne TTDB_TRN_DIR_REP_COMID 103u

MD reply.

• #deﬁne TTDB_TRN_DIR_REP_DS "TTDB_TRAIN_DIRECTORY_INFO_REPLY"

TRAIN_DIRECTORY.

• #deﬁne TTDB_STAT_CST_REQ_COMID 104u

TTDB manager telegram MD: Get the static consist information.

• #deﬁne TTDB_STAT_CST_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne TTDB_STAT_CST_REP_DS "TTDB_STATIC_CONSIST_INFO_REPLY"

Generated by Doxygen

62 File Documentation

CONSIST_INFO.

• #deﬁne TTDB_NET_DIR_REQ_COMID 106u

TTDB manager telegram MD: Get the NETWORK_TRAIN_DIRECTORY.

• #deﬁne TTDB_NET_DIR_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne TTDB_NET_DIR_REP_COMID 107u

MD reply.

• #deﬁne TTDB_NET_DIR_REP_DS "TTDB_TRAIN_NETWORK_DIRECTORY_INFO_REPLY"

TRAIN_NETWORK_DIRECTORY.

• #deﬁne TTDB_OP_DIR_INFO_REQ_COMID 108u

TTDB manager telegram MD: Get the OP_TRAIN_DIRECTORY.

• #deﬁne TTDB_OP_DIR_INFO_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne TTDB_OP_DIR_INFO_REP_DS "TTDB_OP_TRAIN_DIR_INFO"

OP_TRAIN_DIRECTORY.

• #deﬁne TTDB_READ_CMPLT_REQ_COMID 110u

TTDB manager telegram MD: Get the TTDB.

• #deﬁne TTDB_READ_CMPLT_REQ_DS "TTDB_READ_COMPLETE_REQUEST"

ETBx.

• #deﬁne TTDB_READ_CMPLT_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne TTDB_READ_CMPLT_REP_COMID 111u

MD reply.

• #deﬁne TTDB_READ_CMPLT_REP_DS "TTDB_READ_COMPLETE_REPLY"

TRDP_READ_COMPLETE_REPLY_T.

• #deﬁne ECSP_CTRL_COMID 120u

ECSP Control telegram.

• #deﬁne ECSP_CTRL_CYC 1000u

[ms] 1s

• #deﬁne ECSP_CTRL_TO 5000u

[ms] 5s

• #deﬁne ECSP_CTRL_DEST_URI "devECSP.anyVeh.lCst.lClTrn.lTrn"

10.0.0.1

• #deﬁne TRDP_ECSP_CTRL_COMID ECSP_CTRL_COMID

Etb control message.

• #deﬁne ECSP_STATUS_COMID 121u

ECSP status telegram.

• #deﬁne ECSP_STATUS_CYC 1000u

[ms] 1s

• #deﬁne ECSP_STATUS_TO 5000u

[ms] 5s

• #deﬁne ECSP_STATUS_DEST_URI "devECSC.anyVeh.lCst.lClTrn.lTrn"

10.0.0.100

• #deﬁne ECSP_CONF_REQ_COMID 122u

ECSP Conﬁrmation Request telegram MD:

• #deﬁne ECSP_CONF_REQ_TO 3000u

[ms]

• #deﬁne ECSP_CONF_REQ_URI "devECSP.anyVeh.lCst.lClTrn.lTrn"

10.0.0.1

• #deﬁne ECSP_CONF_REP_TO 3000u

[ms]

Generated by Doxygen

5.1 iec61375-2-3.h File Reference 63

• #deﬁne ETBN_CTRL_REQ_COMID 130u

ETBN Control & Status Telegram MD.

• #deﬁne ETBN_CTRL_REQ_DS "ETBN_CTRL"

ETBx.

• #deﬁne ETBN_CTRL_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne ETBN_CTRL_REP_DS "ETBN_STATUS"

ETBN status reply.

• #deﬁne ETBN_TRN_NET_DIR_REQ_COMID 132u

ETBN Control Telegram MD.

• #deﬁne ETBN_TRN_NET_DIR_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne TCN_DNS_REQ_COMID 140u

TCN-DNS Request Telegram MD.

• #deﬁne TCN_DNS_REQ_TO 3000u

[ms] 3s timeout

• #deﬁne TCN_DNS_REQ_TO_US 3000000u

[us] 3s timeout

• #deﬁne TRDP_ETBCTRL_DSID 1u

TRDP reserved data set ids in the range 1 ...

5.1.1 Detailed Description

All deﬁnitions from IEC 61375-2-3.

Note

Project: TCNOpen TRDP

Author

Bernd Loehr, NewTec GmbH, 2015-09-11

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was

not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/.

iec61375-2-3.h 1755 2018-08-07 12:10:03Z bloehr

BL 2018-01-29: Ticket #188 Typo in the TRDP_VAR_SIZE definition

AHW 2017-11-05: Ticket #179 Max. number of retries of a MD request needs to be checked

AHW 2017-05-22: Ticket #159 Infinit timeout at TRDB level is 0 acc. standard

BL 2017-04-28: Ticket #155: Kill trdp_proto.h - move definitions to iec61375-2-3.h

BL 2017-02-08: Ticket #142: Compiler warnings / MISRA-C 2012 issues

BL 2016-05-04: Ticket #118: Fix defines to match IEC IS 2015

from trdp_proto.h

BL 2017-03-13: Ticket #154 ComIds and DSIds literals (#define TRDP_...) in trdp_proto.h too long

BL 2017-03-01: Ticket #149 SourceUri and DestinationUri don’t with 32 characters

BL 2017-02-08: Ticket #142: Compiler warnings / MISRA-C 2012 issues

BL 2016-11-09: Default PD/MD parameter defines moved from trdp_private.h

BL 2016-06-08: Ticket #120: ComIds for statistics changed to proposed 61375 errata

BL 2014-07-14: Ticket #46: Protocol change: operational topocount needed

Generated by Doxygen

64 File Documentation

5.1.2 Macro Deﬁnition Documentation

5.1.2.1 ETB_CTRL_COMID

#define ETB_CTRL_COMID 1u

Reserved COMIDs in the range 1 ...

1000 ETB Control telegram

5.1.2.2 TRDP_ETBCTRL_DSID

#define TRDP_ETBCTRL_DSID 1u

TRDP reserved data set ids in the range 1 ...

1000

5.1.2.3 TRDP_MAX_FILE_NAME_LEN

#define TRDP_MAX_FILE_NAME_LEN 128u

path and ﬁle name length incl.

terminating '0'

5.1.2.4 TRDP_MAX_LABEL_LEN

#define TRDP_MAX_LABEL_LEN 16u

label length incl.

terminating '0'

5.1.2.5 TRDP_MAX_MD_DATA_SIZE

#define TRDP_MAX_MD_DATA_SIZE 65388u

MD packet properties.

MD payload size

Generated by Doxygen

5.1 iec61375-2-3.h File Reference 65

5.1.2.6 TRDP_MAX_URI_HOST_LEN

#define TRDP_MAX_URI_HOST_LEN (4u ∗TRDP_MAX_LABEL_LEN)

URI host part length excl.

terminating '0'

5.1.2.7 TRDP_MAX_URI_LEN

#define TRDP_MAX_URI_LEN ((6u ∗TRDP_MAX_LABEL_LEN) + 8u)

URI length excl.

terminating '0' and 1 padding byte

5.1.2.8 TRDP_MAX_URI_USER_LEN

#define TRDP_MAX_URI_USER_LEN (2u ∗TRDP_MAX_LABEL_LEN)

URI user part excl.

terminating '0'

5.1.2.9 TRDP_MD_DEFAULT_REPLY_TIMEOUT

#define TRDP_MD_DEFAULT_REPLY_TIMEOUT 5000000u

Default MD communication parameters.

[us] default reply timeout 5s

5.1.2.10 TRDP_MD_INFINITE_TIME

#define TRDP_MD_INFINITE_TIME (0)

Deﬁnitions for time out behaviour accd.

table A.18

5.1.2.11 TRDP_MIN_PD_HEADER_SIZE

#define TRDP_MIN_PD_HEADER_SIZE sizeof(PD_HEADER_T)

PD packet properties.

PD header size with FCS

Generated by Doxygen

66 File Documentation

5.1.2.12 TRDP_MSG_PD

#define TRDP_MSG_PD 0x5064u

Message Types.

'Pd' PD Data

5.1.2.13 TRDP_PD_UDP_PORT

#define TRDP_PD_UDP_PORT 17224u

TRDP deﬁnes (from former trpd_proto.h)

IANA assigned process data UDP port

5.1.2.14 TRDP_PROCESS_DEFAULT_CYCLE_TIME

#define TRDP_PROCESS_DEFAULT_CYCLE_TIME 10000u

Default TRDP process options.

[us] 10ms cycle time for TRDP process

5.1.2.15 TRDP_USR_URI_SIZE

#define TRDP_USR_URI_SIZE 32u

max.

User URI size in MD header

5.1.2.16 TTDB_NET_DIR_REQ_COMID

#define TTDB_NET_DIR_REQ_COMID 106u

TTDB manager telegram MD: Get the NETWORK_TRAIN_DIRECTORY.

MD request

5.1.2.17 TTDB_OP_DIR_INFO_COMID

#define TTDB_OP_DIR_INFO_COMID 101u

TTDB manager telegram MD: Push the OP_TRAIN_DIRECTORY.

MD notiﬁcation

Generated by Doxygen

5.2 tau_cstinfo.c File Reference 67

5.1.2.18 TTDB_STAT_CST_REQ_COMID

#define TTDB_STAT_CST_REQ_COMID 104u

TTDB manager telegram MD: Get the static consist information.

MD request

5.1.2.19 TTDB_TRN_DIR_REQ_COMID

#define TTDB_TRN_DIR_REQ_COMID 102u

TTDB manager telegram MD: Get the TRAIN_DIRECTORY.

MD request

5.2 tau_cstinfo.c File Reference

Functions for consist information access.

#include <string.h>

#include <stdio.h>

#include "trdp_if_light.h"

#include "tau_tti.h"

#include "vos_sock.h"

Include dependency graph for tau_cstinfo.c:

tau_cstinfo.c

string.h stdio.h

trdp_if_light.h

vos_sock.h

tau_tti.h

trdp_types.h

vos_types.h

vos_mem.h iec61375-2-3.h

stdint.h

vos_thread.hvos_private.h

tau_tti_types.h

Generated by Doxygen

68 File Documentation

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_cstinfo.c

tau_tti.c

Functions

• UINT16 cstInfoGetPropSize (TRDP_CONSIST_INFO_T ∗pCstInfo)

Getter function to retrieve a value from the consist info telegram value.

5.2.1 Detailed Description

Functions for consist information access.

Note

Project: TCNOpen TRDP prototype stack

Author

B. Loehr (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_cstinfo.c 1646 2017-07-05 14:34:41Z bloehr

BL 2017-05-08: Compiler warnings, doxygen comment errors

BL 2017-04-28: Ticket #155: Kill trdp_proto.h - move definitions to iec61375-2-3.h

BL 2016-02-24: C89 compatibility (thanks to Robert)

5.2.2 Function Documentation

5.2.2.1 cstInfoGetPropSize()

UINT16 cstInfoGetPropSize (

TRDP_CONSIST_INFO_T ∗pCstInfo )

Getter function to retrieve a value from the consist info telegram value.

Generated by Doxygen

5.3 tau_ctrl.c File Reference 69

Parameters

in pCstInfo pointer to packed consist info in network byte order

Return values

len

Here is the call graph for this function:

cstInfoGetPropSize vos_ntohs

5.3 tau_ctrl.c File Reference

Functions for train switch control.

#include <string.h>

#include <stdio.h>

#include "trdp_types.h"

#include "trdp_utils.h"

#include "trdp_if_light.h"

#include "tau_ctrl.h"

Generated by Doxygen

70 File Documentation

Include dependency graph for tau_ctrl.c:

tau_ctrl.c

string.h

stdio.h trdp_types.h

trdp_utils.h

trdp_if_light.h

tau_ctrl.h

vos_types.h

vos_mem.hvos_sock.h iec61375-2-3.h

stdint.h

vos_thread.hvos_private.h

trdp_private.hvos_utils.h

stddef.h

tau_tti.h

tau_ctrl_types.h

tau_tti_types.h

Functions

• EXT_DECL TRDP_ERR_T tau_initEcspCtrl (TRDP_APP_SESSION_T appHandle, TRDP_IP_ADDR_←-

TecspIpAddr)

Function to init ECSP control interface.

• EXT_DECL TRDP_ERR_T tau_terminateEcspCtrl (TRDP_APP_SESSION_T appHandle)

Function to close ECSP control interface.

• EXT_DECL TRDP_ERR_T tau_setEcspCtrl (TRDP_APP_SESSION_T appHandle, TRDP_ECSP_CTRL_T

∗pEcspCtrl)

Function to set ECSP control information.

• EXT_DECL TRDP_ERR_T tau_getEcspStat (TRDP_APP_SESSION_T appHandle, TRDP_ECSP_STAT_T

∗pEcspStat, TRDP_PD_INFO_T ∗pPdInfo)

Function to get ECSP status information.

• EXT_DECL TRDP_ERR_T tau_requestEcspConﬁrm (TRDP_APP_SESSION_T appHandle, const void

∗pUserRef, TRDP_MD_CALLBACK_T pfCbFunction, TRDP_ECSP_CONF_REQUEST_T ∗pEcspConf←-

Request)

Function for ECSP conﬁrmation/correction request, reply will be received via call back.

5.3.1 Detailed Description

Functions for train switch control.

Note

Project: TCNOpen TRDP prototype stack

Generated by Doxygen

5.3 tau_ctrl.c File Reference 71

Author

Armin-H. Weiss (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_ctrl.c 1711 2018-03-06 16:11:32Z bloehr

BL 2018-03-06: Ticket #101 Optional callback function on PD send

AHW 2017-11-08: Ticket #179 Max. number of retries (part of sendParam) of a MD request needs to be checked

BL 2017-04-28: Ticket #155: Kill trdp_proto.h - move definitions to iec61375-2-3.h

5.3.2 Function Documentation

5.3.2.1 tau_getEcspStat()

EXT_DECL TRDP_ERR_T tau_getEcspStat (

TRDP_APP_SESSION_T appHandle,

TRDP_ECSP_STAT_T ∗pEcspStat,

TRDP_PD_INFO_T ∗pPdInfo )

Function to get ECSP status information.

Parameters

in appHandle Application handle

in,out pEcspStat Pointer to the ECSP status structure

in,out pPdInfo Pointer to PD status information

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

5.3.2.2 tau_initEcspCtrl()

EXT_DECL TRDP_ERR_T tau_initEcspCtrl (

TRDP_APP_SESSION_T appHandle,

TRDP_IP_ADDR_T ecspIpAddr )

Generated by Doxygen

72 File Documentation

Function to init ECSP control interface.

Generated by Doxygen

5.3 tau_ctrl.c File Reference 73

Parameters

in appHandle Application handle

in ecspIpAddr ECSP address

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR initialisation error

5.3.2.3 tau_requestEcspConﬁrm()

EXT_DECL TRDP_ERR_T tau_requestEcspConfirm (

TRDP_APP_SESSION_T appHandle,

const void ∗pUserRef,

TRDP_MD_CALLBACK_T pfCbFunction,

TRDP_ECSP_CONF_REQUEST_T ∗pEcspConfRequest )

Function for ECSP conﬁrmation/correction request, reply will be received via call back.

Parameters

in appHandle Application Handle

in pUserRef user reference returned with reply

in pfCbFunction Pointer to callback function, NULL for default

in pEcspConfRequest Pointer to conﬁrmation data

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

5.3.2.4 tau_setEcspCtrl()

EXT_DECL TRDP_ERR_T tau_setEcspCtrl (

TRDP_APP_SESSION_T appHandle,

TRDP_ECSP_CTRL_T ∗pEcspCtrl )

Function to set ECSP control information.

Parameters

in appHandle Application handle

in pEcspCtrl Pointer to the ECSP control structure

Generated by Doxygen

74 File Documentation

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

5.3.2.5 tau_terminateEcspCtrl()

EXT_DECL TRDP_ERR_T tau_terminateEcspCtrl (

TRDP_APP_SESSION_T appHandle )

Function to close ECSP control interface.

Parameters

in appHandle Application handle

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_UNKNOWN_ERR undeﬁned error

5.4 tau_ctrl.h File Reference

TRDP utility interface deﬁnitions.

#include "trdp_types.h"

#include "tau_tti.h"

#include "tau_ctrl_types.h"

Generated by Doxygen

5.4 tau_ctrl.h File Reference 75

Include dependency graph for tau_ctrl.h:

tau_ctrl.h

trdp_types.h

tau_tti.h

tau_ctrl_types.h

vos_types.h

vos_mem.h vos_sock.h iec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

tau_tti_types.h

Generated by Doxygen

76 File Documentation

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_ctrl.h

tau_ctrl.c

Functions

• EXT_DECL TRDP_ERR_T tau_initEcspCtrl (TRDP_APP_SESSION_T appHandle, TRDP_IP_ADDR_←-

TecspIpAddr)

Function to init ECSP control interface.

• EXT_DECL TRDP_ERR_T tau_terminateEcspCtrl (TRDP_APP_SESSION_T appHandle)

Function to close ECSP control interface.

• EXT_DECL TRDP_ERR_T tau_setEcspCtrl (TRDP_APP_SESSION_T appHandle, TRDP_ECSP_CTRL_T

∗pEcspCtrl)

Function to set ECSP control information.

• EXT_DECL TRDP_ERR_T tau_getEcspStat (TRDP_APP_SESSION_T appHandle, TRDP_ECSP_STAT_T

∗pEcspStat, TRDP_PD_INFO_T ∗pPdInfo)

Function to get ECSP status information.

• EXT_DECL TRDP_ERR_T tau_requestEcspConﬁrm (TRDP_APP_SESSION_T appHandle, const void

∗pUserRef, TRDP_MD_CALLBACK_T pfCbFunction, TRDP_ECSP_CONF_REQUEST_T ∗pEcspConf←-

Request)

Function for ECSP conﬁrmation/correction request, reply will be received via call back.

5.4.1 Detailed Description

TRDP utility interface deﬁnitions.

This module provides the interface to the following utilities

• ETB control

Note

Project: TCNOpen TRDP prototype stack

Author

Armin-H. Weiss (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_ctrl.h 1483 2015-12-16 14:43:30Z bloehr

Generated by Doxygen

5.4 tau_ctrl.h File Reference 77

5.4.2 Function Documentation

5.4.2.1 tau_getEcspStat()

EXT_DECL TRDP_ERR_T tau_getEcspStat (

TRDP_APP_SESSION_T appHandle,

TRDP_ECSP_STAT_T ∗pEcspStat,

TRDP_PD_INFO_T ∗pPdInfo )

Function to get ECSP status information.

Parameters

in appHandle Application Handle

in,out pEcspStat Pointer to the ECSP status structure

in,out pPdInfo Pointer to PD status information

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

Parameters

in appHandle Application handle

in,out pEcspStat Pointer to the ECSP status structure

in,out pPdInfo Pointer to PD status information

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

5.4.2.2 tau_initEcspCtrl()

EXT_DECL TRDP_ERR_T tau_initEcspCtrl (

TRDP_APP_SESSION_T appHandle,

TRDP_IP_ADDR_T ecspIpAddr )

Function to init ECSP control interface.

Parameters

in appHandle Application handle

in ecspIpAddr ECSP address

Generated by Doxygen

78 File Documentation

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR initialisation error

5.4.2.3 tau_requestEcspConﬁrm()

EXT_DECL TRDP_ERR_T tau_requestEcspConfirm (

TRDP_APP_SESSION_T appHandle,

const void ∗pUserRef,

TRDP_MD_CALLBACK_T pfCbFunction,

TRDP_ECSP_CONF_REQUEST_T ∗pEcspConfRequest )

Function for ECSP conﬁrmation/correction request, reply will be received via call back.

Parameters

in appHandle Application Handle

in pUserRef user reference returned with reply

in pfCbFunction Pointer to callback function, NULL for default

in pEcspConfRequest Pointer to conﬁrmation data

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

5.4.2.4 tau_setEcspCtrl()

EXT_DECL TRDP_ERR_T tau_setEcspCtrl (

TRDP_APP_SESSION_T appHandle,

TRDP_ECSP_CTRL_T ∗pEcspCtrl )

Function to set ECSP control information.

Parameters

in appHandle Application handle

in pEcspCtrl Pointer to the ECSP control structure

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_PARAM_ERR Parameter error

Generated by Doxygen

5.5 tau_ctrl_types.h File Reference 79

5.4.2.5 tau_terminateEcspCtrl()

EXT_DECL TRDP_ERR_T tau_terminateEcspCtrl (

TRDP_APP_SESSION_T appHandle )

Function to close ECSP control interface.

Parameters

in appHandle Application handle

Return values

TRDP_NO_ERR no error

TRDP_UNKNOWN_ERR undeﬁned error

Parameters

in appHandle Application handle

Return values

TRDP_NO_ERR no error

TRDP_NOINIT_ERR module not initialised

TRDP_UNKNOWN_ERR undeﬁned error

5.5 tau_ctrl_types.h File Reference

TRDP utility interface deﬁnitions.

#include "trdp_types.h"

#include "tau_tti.h"

Generated by Doxygen

80 File Documentation

Include dependency graph for tau_ctrl_types.h:

tau_ctrl_types.h

trdp_types.h

tau_tti.h

vos_types.h

vos_mem.h vos_sock.h iec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

tau_tti_types.h

Generated by Doxygen

5.5 tau_ctrl_types.h File Reference 81

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_ctrl_types.h

tau_ctrl.h

tau_ctrl.c

Data Structures

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

• struct GNU_PACKED

Types for ETB control.

5.5.1 Detailed Description

TRDP utility interface deﬁnitions.

This module provides the interface to the following

• ETB control type deﬁnitions acc. to IEC61375-2-3

Generated by Doxygen

82 File Documentation

Note

Project: TCNOpen TRDP prototype stack

Author

Armin-H. Weiss (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_ctrl_types.h 1763 2018-09-21 16:03:13Z ahweiss

BL 2017-11-13: Ticket #176 TRDP_LABEL_T breaks field alignment -> TRDP_NET_LABEL_T

BL 2017-03-09: Ticket #131 errata: Last change undone (leadVehOfCst defined in corrigendum)

BL 2017-02-09: Ticket #131 TRDP_ECSP_CTRL_T in the tau_ctrl_types.h should not include the leadVehOfCst field

5.6 tau_dnr.c File Reference

Functions for domain name resolution.

#include <string.h>

#include <stdio.h>

#include <ctype.h>

#include "tau_tti.h"

#include "tau_dnr.h"

#include "tau_dnr_types.h"

#include "trdp_utils.h"

#include "trdp_if_light.h"

#include "vos_mem.h"

#include "vos_sock.h"

Include dependency graph for tau_dnr.c:

tau_dnr.c

string.h

stdio.h

ctype.htau_tti.h

vos_mem.hvos_sock.h

tau_dnr.h tau_dnr_types.h

trdp_utils.h trdp_if_light.h

trdp_types.h

tau_tti_types.h

vos_types.h

iec61375-2-3.h

stdint.h

vos_thread.hvos_private.h

trdp_private.hvos_utils.h

stddef.h

Generated by Doxygen

5.6 tau_dnr.c File Reference 83

Data Structures

• struct DNS_HEADER

DNS header structure.

Macros

• #deﬁne TAU_MAX_NO_IF 4u

Default interface should be in the ﬁrst 4.

• #deﬁne TAU_DNS_TIME_OUT_LONG 10u

Timeout in seconds for DNS server reply, if no hosts ﬁle provided.

• #deﬁne TAU_DNS_TIME_OUT_SHORT 1u

Timeout in seconds for DNS server reply, if hosts ﬁle was provided.

• #deﬁne TAU_MAX_HOST_URI_LEN 80u

Including EOS!

Typedefs

• typedef struct DNS_HEADER TAU_DNS_HEADER_T

DNS header structure.

Functions

• EXT_DECL TRDP_ERR_T tau_initDnr (TRDP_APP_SESSION_T appHandle, TRDP_IP_ADDR_T dnsIp←-

Addr, UINT16 dnsPort, const CHAR8 ∗pHostsFileName, TRDP_DNR_OPTS_T dnsOptions)

Function to init the DNR subsystem Initialize the DNR resolver.

• EXT_DECL void tau_deInitDnr (TRDP_APP_SESSION_T appHandle)

Function to deinit DNR.

• EXT_DECL TRDP_DNR_STATE_T tau_DNRstatus (TRDP_APP_SESSION_T appHandle)

Function to get the status of DNR.

• EXT_DECL TRDP_IP_ADDR_T tau_getOwnAddr (TRDP_APP_SESSION_T appHandle)

Function to get the own IP address.

• EXT_DECL TRDP_ERR_T tau_uri2Addr (TRDP_APP_SESSION_T appHandle, TRDP_IP_ADDR_T ∗p←-

Addr, const TRDP_URI_T pUri)

Function to convert a URI to an IP address.

• EXT_DECL TRDP_ERR_T tau_addr2Uri (TRDP_APP_SESSION_T appHandle, TRDP_URI_HOST_T pUri,

TRDP_IP_ADDR_T addr)

Function to convert an IP address to a URI.

5.6.1 Detailed Description

Functions for domain name resolution.

Note

Project: TCNOpen TRDP prototype stack

Generated by Doxygen

84 File Documentation

Author

B. Loehr (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_dnr.c 1763 2018-09-21 16:03:13Z ahweiss

BL 2018-08-07: Ticket #183 tau_getOwnIds declared but not defined

BL 2018-08-06: Ticket #210 IF condition for DNS Options incorrect in tau_uri2Addr()

BL 2018-06-20: Ticket #184: Building with VS 2015: WIN64 and Windows threads (SOCKET instead of INT32)

BL 2018-05-03: Ticket #193 Unused parameter warnings

AHW 2017-11-08: Ticket #179 Max. number of retries (part of sendParam) of a MD request needs to be checked

BL 2017-07-25: Ticket #125: tau_dnr: TCN DNS support missing

BL 2017-05-08: Compiler warnings

BL 2017-03-01: Ticket #149 SourceUri and DestinationUri don’t with 32 characters

BL 2017-02-08: Ticket #124 tau_dnr: Cache keeps etbTopoCount only

BL 2015-12-14: Ticket #8: DNR client

5.6.2 Function Documentation

5.6.2.1 tau_addr2Uri()

EXT_DECL TRDP_ERR_T tau_addr2Uri (

TRDP_APP_SESSION_T appHandle,

TRDP_URI_HOST_T pUri,

TRDP_IP_ADDR_T addr )

Function to convert an IP address to a URI.

Receives an IP-Address and translates it into the host part of the corresponding URI. Both unicast and multicast

addresses are accepted.

Parameters

in appHandle Handle returned by tlc_openSession()

out pUri Pointer to a string to return the URI host part

in addr IP address, 0==own address

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

Generated by Doxygen

5.6 tau_dnr.c File Reference 85

5.6.2.2 tau_deInitDnr()

EXT_DECL void tau_deInitDnr (

TRDP_APP_SESSION_T appHandle )

Function to deinit DNR.

Release any resources allocated by DNR.

Parameters

in appHandle Handle returned by tlc_openSession()

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.6.2.3 tau_DNRstatus()

EXT_DECL TRDP_DNR_STATE_T tau_DNRstatus (

TRDP_APP_SESSION_T appHandle )

Function to get the status of DNR.

Parameters

in appHandle Handle returned by tlc_openSession()

Return values

TRDP_DNR_NOT_AVAILABLE no error

TRDP_DNR_UNKNOWN enabled, but cache is empty

TRDP_DNR_ACTIVE enabled, cache has values

TRDP_DNR_HOSTSFILE enabled, hostsﬁle used (static mode)

5.6.2.4 tau_getOwnAddr()

EXT_DECL TRDP_IP_ADDR_T tau_getOwnAddr (

TRDP_APP_SESSION_T appHandle )

Function to get the own IP address.

Returns the IP address set by openSession. If it was 0 (INADDR_ANY), the address of the default adapter will be

returned.

Generated by Doxygen

86 File Documentation

Parameters

in appHandle Handle returned by tlc_openSession()

Return values

own IP address

5.6.2.5 tau_initDnr()

EXT_DECL TRDP_ERR_T tau_initDnr (

TRDP_APP_SESSION_T appHandle,

TRDP_IP_ADDR_T dnsIpAddr,

UINT16 dnsPort,

const CHAR8 ∗pHostsFileName,

TRDP_DNR_OPTS_T dnsOptions )

Function to init the DNR subsystem Initialize the DNR resolver.

Function to init DNR.

Depending on the supplied options, three operational modes are supported:

1. TRDP_DNR_COMMON_THREAD (default) Expect tlc_process running in a different, separate thread

2. TRDP_DNR_OWN_THREAD For single threaded systems only! Internally call tlc_process()

3. TRDP_DNR_STANDARD_DNS Use standard DNS instead of TCN-DNS. Default dnsPort (= 0) for TCN-DNS

is 17225, for standard DNS it is 53.

Parameters

in appHandle Handle returned by tlc_openSession().

in dnsIpAddr DNS/ECSP IP address.

in dnsPort DNS port number.

in pHostsFileName Optional host ﬁle name as ECSP replacement/addition.

in dnsOptions Use existing thread (recommended), use own tlc_process loop or use standard DNS

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR initialisation error

<default DNR/ECSP settings

5.6.2.6 tau_uri2Addr()

EXT_DECL TRDP_ERR_T tau_uri2Addr (

TRDP_APP_SESSION_T appHandle,

Generated by Doxygen

5.7 tau_dnr.h File Reference 87

TRDP_IP_ADDR_T ∗pAddr,

const TRDP_URI_T pUri )

Function to convert a URI to an IP address.

Receives an URI as input variable and translates this URI to an IP-Address. The URI may specify either a unicast

or a multicast IP-Address.

Parameters

in appHandle Handle returned by tlc_openSession()

out pAddr Pointer to return the IP address

in pUri Pointer to an URI or an IP Address string, NULL==own URI

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_UNRESOLVED_ERR Could not resolve error

TRDP_TOPO_ERR Cache/DB entry is invalid

5.7 tau_dnr.h File Reference

TRDP utility interface deﬁnitions.

Generated by Doxygen

88 File Documentation

#include "trdp_types.h"

Include dependency graph for tau_dnr.h:

tau_dnr.h

trdp_types.h

vos_types.h

vos_mem.h vos_sock.h iec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_dnr.h

tau_dnr.c tau_tti.c

Functions

• EXT_DECL TRDP_ERR_T tau_initDnr (TRDP_APP_SESSION_T appHandle, TRDP_IP_ADDR_T dnsIp←-

Addr, UINT16 dnsPort, const CHAR8 ∗pHostsFileName, TRDP_DNR_OPTS_T dnsOptions)

Generated by Doxygen

5.7 tau_dnr.h File Reference 89

Function to init DNR.

• EXT_DECL void tau_deInitDnr (TRDP_APP_SESSION_T appHandle)

Release any resources allocated by DNR.

• EXT_DECL TRDP_DNR_STATE_T tau_DNRstatus (TRDP_APP_SESSION_T appHandle)

Function to get the status of DNR.

• EXT_DECL TRDP_IP_ADDR_T tau_getOwnAddr (TRDP_APP_SESSION_T appHandle)

Function to get the own IP address.

• EXT_DECL TRDP_ERR_T tau_uri2Addr (TRDP_APP_SESSION_T appHandle, TRDP_IP_ADDR_T ∗p←-

Addr, const TRDP_URI_T pUri)

Function to convert a URI to an IP address.

• EXT_DECL TRDP_ERR_T tau_addr2Uri (TRDP_APP_SESSION_T appHandle, TRDP_URI_HOST_T pUri,

TRDP_IP_ADDR_T addr)

Function to convert an IP address to a URI.

5.7.1 Detailed Description

TRDP utility interface deﬁnitions.

This module provides the interface to the following utilities

• IP - URI address translation

Note

Project: TCNOpen TRDP prototype stack

Author

Armin-H. Weiss (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_dnr.h 1755 2018-08-07 12:10:03Z bloehr

BL 2018-08-07: Ticket #183 tau_getOwnIds moved here

BL 2017-07-25: Ticket #125: tau_dnr: TCN DNS support missing

BL 2015-12-14: Ticket #8: DNR client

5.7.2 Function Documentation

5.7.2.1 tau_addr2Uri()

EXT_DECL TRDP_ERR_T tau_addr2Uri (

TRDP_APP_SESSION_T appHandle,

TRDP_URI_HOST_T pUri,

TRDP_IP_ADDR_T addr )

Function to convert an IP address to a URI.

Receives an IP-Address and translates it into the host part of the corresponding URI. Both unicast and multicast

addresses are accepted.

Generated by Doxygen

90 File Documentation

Parameters

in appHandle Handle returned by tlc_openSession().

out pUri Pointer to a string to return the URI host part

in addr IP address, 0==own address

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

Receives an IP-Address and translates it into the host part of the corresponding URI. Both unicast and multicast

addresses are accepted.

Parameters

in appHandle Handle returned by tlc_openSession()

out pUri Pointer to a string to return the URI host part

in addr IP address, 0==own address

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.7.2.2 tau_deInitDnr()

EXT_DECL void tau_deInitDnr (

TRDP_APP_SESSION_T appHandle )

Release any resources allocated by DNR.

Parameters

in appHandle Handle returned by tlc_openSession().

Return values

none Release any resources allocated by DNR.

Parameters

in appHandle Handle returned by tlc_openSession()

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

Generated by Doxygen

5.7 tau_dnr.h File Reference 91

5.7.2.3 tau_DNRstatus()

EXT_DECL TRDP_DNR_STATE_T tau_DNRstatus (

TRDP_APP_SESSION_T appHandle )

Function to get the status of DNR.

Parameters

in appHandle Handle returned by tlc_openSession()

Return values

TRDP_DNR_NOT_AVAILABLE no error

TRDP_DNR_UNKNOWN enabled, but cache is empty

TRDP_DNR_ACTIVE enabled, cache has values

TRDP_DNR_HOSTSFILE enabled, hostsﬁle used (static mode)

5.7.2.4 tau_getOwnAddr()

EXT_DECL TRDP_IP_ADDR_T tau_getOwnAddr (

TRDP_APP_SESSION_T appHandle )

Function to get the own IP address.

Parameters

in appHandle Handle returned by tlc_openSession().

Return values

own IP address

Returns the IP address set by openSession. If it was 0 (INADDR_ANY), the address of the default adapter will be

returned.

Parameters

in appHandle Handle returned by tlc_openSession()

Return values

own IP address

Generated by Doxygen

92 File Documentation

5.7.2.5 tau_initDnr()

EXT_DECL TRDP_ERR_T tau_initDnr (

TRDP_APP_SESSION_T appHandle,

TRDP_IP_ADDR_T dnsIpAddr,

UINT16 dnsPort,

const CHAR8 ∗pHostsFileName,

TRDP_DNR_OPTS_T dnsOptions )

Function to init DNR.

Parameters

in appHandle Handle returned by tlc_openSession().

in dnsIpAddr DNS/ECSP IP address.

in dnsPort DNS port number.

in pHostsFileName Optional host ﬁle name as ECSP replacement/addition.

in dnsOptions Use existing thread (recommended), use own tlc_process loop or use standard DNS

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR initialisation error

Function to init DNR.

Depending on the supplied options, three operational modes are supported:

1. TRDP_DNR_COMMON_THREAD (default) Expect tlc_process running in a different, separate thread

2. TRDP_DNR_OWN_THREAD For single threaded systems only! Internally call tlc_process()

3. TRDP_DNR_STANDARD_DNS Use standard DNS instead of TCN-DNS. Default dnsPort (= 0) for TCN-DNS

is 17225, for standard DNS it is 53.

Parameters

in appHandle Handle returned by tlc_openSession().

in dnsIpAddr DNS/ECSP IP address.

in dnsPort DNS port number.

in pHostsFileName Optional host ﬁle name as ECSP replacement/addition.

in dnsOptions Use existing thread (recommended), use own tlc_process loop or use standard DNS

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR initialisation error

<default DNR/ECSP settings

Generated by Doxygen

5.8 tau_dnr_types.h File Reference 93

5.7.2.6 tau_uri2Addr()

EXT_DECL TRDP_ERR_T tau_uri2Addr (

TRDP_APP_SESSION_T appHandle,

TRDP_IP_ADDR_T ∗pAddr,

const TRDP_URI_T pUri )

Function to convert a URI to an IP address.

Receives a URI as input variable and translates this URI to an IP-Address. The URI may specify either a unicast or

a multicast IP-Address. The caller may specify a topographic counter, which will be checked.

Parameters

in appHandle Handle returned by tlc_openSession().

out pAddr Pointer to return the IP address

in pUri Pointer to a URI or an IP Address string, NULL==own URI

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

Receives an URI as input variable and translates this URI to an IP-Address. The URI may specify either a unicast

or a multicast IP-Address.

Parameters

in appHandle Handle returned by tlc_openSession()

out pAddr Pointer to return the IP address

in pUri Pointer to an URI or an IP Address string, NULL==own URI

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_UNRESOLVED_ERR Could not resolve error

TRDP_TOPO_ERR Cache/DB entry is invalid

5.8 tau_dnr_types.h File Reference

TRDP utility interface deﬁnitions.

Generated by Doxygen

94 File Documentation

#include "trdp_types.h"

Include dependency graph for tau_dnr_types.h:

tau_dnr_types.h

trdp_types.h

vos_types.h

vos_mem.h vos_sock.h iec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_dnr_types.h

tau_dnr.c

Data Structures

• struct TCN_URI

Generated by Doxygen

5.8 tau_dnr_types.h File Reference 95

TCN-DNS simpliﬁed header structures.

• struct TRDP_DNS_REQUEST

TCN-DNS Request telegram TCN_DNS_REQ_DS.

• struct TRDP_DNS_REPLY

TCN-DNS Reply telegram TCN_DNS_REP_DS.

Typedefs

• typedef struct TCN_URI TCN_URI_T

TCN-DNS simpliﬁed header structures.

• typedef struct TRDP_DNS_REQUEST TRDP_DNS_REQUEST_T

TCN-DNS Request telegram TCN_DNS_REQ_DS.

• typedef struct TRDP_DNS_REPLY TRDP_DNS_REPLY_T

TCN-DNS Reply telegram TCN_DNS_REP_DS.

5.8.1 Detailed Description

TRDP utility interface deﬁnitions.

This module provides typedefs to the following utilities

• IP - URI address translation

Note

Project: TCNOpen TRDP prototype stack

Author

Bernd Löhr (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

BL 2017-11-13: Ticket #176 TRDP_LABEL_T breaks field alignment -> TRDP_NET_LABEL_T

BL 2017-07-25: Ticket #125: TCN-DNR client

Generated by Doxygen

96 File Documentation

5.9 tau_marshall.c File Reference

Marshalling functions for TRDP.

#include <string.h>

#include "trdp_types.h"

#include "trdp_if_light.h"

#include "trdp_utils.h"

#include "vos_mem.h"

#include "tau_marshall.h"

Include dependency graph for tau_marshall.c:

tau_marshall.c

string.h

trdp_types.h

vos_mem.h

trdp_if_light.h

trdp_utils.htau_marshall.h

vos_types.h

vos_sock.hiec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

stdio.h

trdp_private.h vos_utils.h

stddef.h

Data Structures

• struct TAU_MARSHALL_INFO_T

Marshalling info, used to and from wire.

Functions

• EXT_DECL TRDP_ERR_T tau_initMarshall (void ∗∗ppRefCon, UINT32 numComId, TRDP_COMID_DSID←-

_MAP_T ∗pComIdDsIdMap, UINT32 numDataSet, TRDP_DATASET_T ∗pDataset[ ])

Function to initialise the marshalling/unmarshalling.

• EXT_DECL TRDP_ERR_T tau_marshall (void ∗pRefCon, UINT32 comId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

marshall function.

• EXT_DECL TRDP_ERR_T tau_unmarshall (void ∗pRefCon, UINT32 comId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

unmarshall function.

• EXT_DECL TRDP_ERR_T tau_marshallDs (void ∗pRefCon, UINT32 dsId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

marshall data set function.

Generated by Doxygen

5.9 tau_marshall.c File Reference 97

• EXT_DECL TRDP_ERR_T tau_unmarshallDs (void ∗pRefCon, UINT32 dsId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

unmarshall data set function.

• EXT_DECL TRDP_ERR_T tau_calcDatasetSize (void ∗pRefCon, UINT32 dsId, UINT8 ∗pSrc, UINT32 src←-

Size, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

Calculate data set size by given data set id.

• EXT_DECL TRDP_ERR_T tau_calcDatasetSizeByComId (void ∗pRefCon, UINT32 comId, UINT8 ∗pSrc, U←-

INT32 srcSize, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

Calculate data set size by given ComId.

5.9.1 Detailed Description

Marshalling functions for TRDP.

Note

Project: TCNOpen TRDP prototype stack

Author

Bernd Loehr, NewTec GmbH

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_marshall.c 1748 2018-07-13 15:59:36Z bloehr

BL 2018-06-20: Ticket #184: Building with VS 2015: WIN64 and Windows threads (SOCKET instead of INT32)

SW 2018-06-12: Ticket #203 Incorrect unmarshalling of datasets containing TIMEDATE64 array

BL 2018-05-17: Ticket #197 Incorrect Marshalling/Unmarshalling for nested datasets

BL 2018-05-15: Wrong source size/range should not lead to marshalling error, check discarded

BL 2018-05-03: Ticket #193 Unused parameter warnings

BL 2018-05-02: Ticket #188 Typo in the TRDP_VAR_SIZE definition

BL 2017-05-08: Compiler warnings, MISRA-C

BL 2017-05-08: Ticket #156 Recursion counter never decremented (+ compiler warnings, MISRA)

BL 2016-07-06: Ticket #122 64Bit compatibility (+ compiler warnings), alignment casts fixed

BL 2016-02-11: Ticket #108: missing initialisation of size-pointer

BL 2016-02-04: Ticket #109: size_marshall -> size_unmarshall

BL 2016-02-03: Ticket #108: Uninitialized info variable

BL 2015-12-14: Ticket #33: source size check for marshalling

5.9.2 Function Documentation

5.9.2.1 tau_calcDatasetSize()

EXT_DECL TRDP_ERR_T tau_calcDatasetSize (

void ∗pRefCon,

UINT32 dsId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

Calculate data set size by given data set id.

Generated by Doxygen

98 File Documentation

Parameters

in pRefCon Pointer to user context

in dsId Dataset id to identify the structure out of a conﬁguration

in pSrc Pointer to received original message

in srcSize size of the source buffer

out pDestSize Pointer to the size of the data set

in,out ppDSPointer pointer to pointer to cached dataset, set NULL if not used, set content NULL if

unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

5.9.2.2 tau_calcDatasetSizeByComId()

EXT_DECL TRDP_ERR_T tau_calcDatasetSizeByComId (

void ∗pRefCon,

UINT32 comId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

Calculate data set size by given ComId.

Parameters

in pRefCon Pointer to user context

in comId ComId id to identify the structure out of a conﬁguration

in pSrc Pointer to received original message

in srcSize size of the source buffer

out pDestSize Pointer to the size of the data set

in,out ppDSPointer pointer to pointer to cached dataset, set NULL if not used, set content NULL if

unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

Generated by Doxygen

5.9 tau_marshall.c File Reference 99

Return values

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

5.9.2.3 tau_initMarshall()

EXT_DECL TRDP_ERR_T tau_initMarshall (

void ∗∗ ppRefCon,

UINT32 numComId,

TRDP_COMID_DSID_MAP_T ∗pComIdDsIdMap,

UINT32 numDataSet,

TRDP_DATASET_T ∗pDataset[ ] )

Function to initialise the marshalling/unmarshalling.

Types for marshalling / unmarshalling.

The supplied array must be sorted by ComIds. The array must exist during the use of the marshalling functions

(until tlc_terminate()).

Parameters

in,out ppRefCon Returns a pointer to be used for the reference context of

marshalling/unmarshalling

in numComId Number of datasets found in the conﬁguration

in pComIdDsIdMap Pointer to an array of structures of type TRDP_DATASET_T

in numDataSet Number of datasets found in the conﬁguration

in pDataset Pointer to an array of pointers to structures of type TRDP_DATASET_T

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

5.9.2.4 tau_marshall()

EXT_DECL TRDP_ERR_T tau_marshall (

void ∗pRefCon,

UINT32 comId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

marshall function.

Generated by Doxygen

100 File Documentation

Parameters

in pRefCon pointer to user context

in comId ComId to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_MARSHALLING_ERR dataset/source size mismatch

5.9.2.5 tau_marshallDs()

EXT_DECL TRDP_ERR_T tau_marshallDs (

void ∗pRefCon,

UINT32 dsId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

marshall data set function.

Parameters

in pRefCon pointer to user context

in dsId Data set id to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

Generated by Doxygen

5.9 tau_marshall.c File Reference 101

Return values

TRDP_MARSHALLING_ERR dataset/source size mismatch

5.9.2.6 tau_unmarshall()

EXT_DECL TRDP_ERR_T tau_unmarshall (

void ∗pRefCon,

UINT32 comId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

unmarshall function.

Parameters

in pRefCon pointer to user context

in comId ComId to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

5.9.2.7 tau_unmarshallDs()

EXT_DECL TRDP_ERR_T tau_unmarshallDs (

void ∗pRefCon,

UINT32 dsId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

Generated by Doxygen

102 File Documentation

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

unmarshall data set function.

Parameters

in pRefCon pointer to user context

in dsId Data set id to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

5.10 tau_marshall.h File Reference

TRDP utility interface deﬁnitions.

Generated by Doxygen

5.10 tau_marshall.h File Reference 103

#include "trdp_types.h"

Include dependency graph for tau_marshall.h:

tau_marshall.h

trdp_types.h

vos_types.h

vos_mem.h vos_sock.h iec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_marshall.h

tau_marshall.c tau_tti.c

Functions

• EXT_DECL TRDP_ERR_T tau_initMarshall (void ∗∗ppRefCon, UINT32 numComId, TRDP_COMID_DSID←-

_MAP_T ∗pComIdDsIdMap, UINT32 numDataSet, TRDP_DATASET_T ∗pDataset[ ])

Generated by Doxygen

104 File Documentation

Types for marshalling / unmarshalling.

• EXT_DECL TRDP_ERR_T tau_marshall (void ∗pRefCon, UINT32 comId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

marshall function.

• EXT_DECL TRDP_ERR_T tau_marshallDs (void ∗pRefCon, UINT32 dsId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

marshall data set function.

• EXT_DECL TRDP_ERR_T tau_unmarshall (void ∗pRefCon, UINT32 comId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

unmarshall function.

• EXT_DECL TRDP_ERR_T tau_unmarshallDs (void ∗pRefCon, UINT32 dsId, UINT8 ∗pSrc, UINT32 srcSize,

UINT8 ∗pDest, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

unmarshall data set function.

• EXT_DECL TRDP_ERR_T tau_calcDatasetSize (void ∗pRefCon, UINT32 dsId, UINT8 ∗pSrc, UINT32 src←-

Size, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

Calculate data set size by given data set id.

• EXT_DECL TRDP_ERR_T tau_calcDatasetSizeByComId (void ∗pRefCon, UINT32 comId, UINT8 ∗pSrc, U←-

INT32 srcSize, UINT32 ∗pDestSize, TRDP_DATASET_T ∗∗ppDSPointer)

Calculate data set size by given ComId.

5.10.1 Detailed Description

TRDP utility interface deﬁnitions.

This module provides the interface to the following utilities

• marshalling/unmarshalling

Note

Project: TCNOpen TRDP prototype stack

Author

Armin-H. Weiss

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_marshall.h 1479 2015-12-14 14:53:45Z bloehr

BL 2015-12-14: Ticket #33: source size check for marshalling

5.10.2 Function Documentation

Generated by Doxygen

5.10 tau_marshall.h File Reference 105

5.10.2.1 tau_calcDatasetSize()

EXT_DECL TRDP_ERR_T tau_calcDatasetSize (

void ∗pRefCon,

UINT32 dsId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

Calculate data set size by given data set id.

Parameters

in pRefCon Pointer to user context

in dsId Dataset id to identify the structure out of a conﬁguration

in pSrc Pointer to received original message

in srcSize size of the source buffer

out pDestSize Pointer to the size of the data set

in,out ppDSPointer pointer to pointer to cached dataset, set NULL if not used, set content NULL if

unknown

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR marshalling not initialised

TRDP_PARAM_ERR data set id not existing

Parameters

in pRefCon Pointer to user context

in dsId Dataset id to identify the structure out of a conﬁguration

in pSrc Pointer to received original message

in srcSize size of the source buffer

out pDestSize Pointer to the size of the data set

in,out ppDSPointer pointer to pointer to cached dataset, set NULL if not used, set content NULL if

unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

Generated by Doxygen

106 File Documentation

5.10.2.2 tau_calcDatasetSizeByComId()

EXT_DECL TRDP_ERR_T tau_calcDatasetSizeByComId (

void ∗pRefCon,

UINT32 comId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

Calculate data set size by given ComId.

Parameters

in pRefCon Pointer to user context

in comId ComId id to identify the structure out of a conﬁguration

in pSrc Pointer to received original message

in srcSize size of the source buffer

out pDestSize Pointer to the size of the data set

in,out ppDSPointer pointer to pointer to cached dataset, set NULL if not used, set content NULL if

unknown

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR marshalling not initialised

TRDP_PARAM_ERR data set id not existing

Parameters

in pRefCon Pointer to user context

in comId ComId id to identify the structure out of a conﬁguration

in pSrc Pointer to received original message

in srcSize size of the source buffer

out pDestSize Pointer to the size of the data set

in,out ppDSPointer pointer to pointer to cached dataset, set NULL if not used, set content NULL if

unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

Generated by Doxygen

5.10 tau_marshall.h File Reference 107

5.10.2.3 tau_initMarshall()

EXT_DECL TRDP_ERR_T tau_initMarshall (

void ∗∗ ppRefCon,

UINT32 numComId,

TRDP_COMID_DSID_MAP_T ∗pComIdDsIdMap,

UINT32 numDataSet,

TRDP_DATASET_T ∗pDataset[ ] )

Types for marshalling / unmarshalling.

Function to initialise the marshalling/unmarshalling.

Parameters

in,out ppRefCon Returns a pointer to be used for the reference context of

marshalling/unmarshalling

in numComId Number of datasets found in the conﬁguration

in pComIdDsIdMap Pointer to an array of structures of type TRDP_DATASET_T

in numDataSet Number of datasets found in the conﬁguration

in pDataset Pointer to an array of pointers to structures of type TRDP_DATASET_T

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

Types for marshalling / unmarshalling.

The supplied array must be sorted by ComIds. The array must exist during the use of the marshalling functions

(until tlc_terminate()).

Parameters

in,out ppRefCon Returns a pointer to be used for the reference context of

marshalling/unmarshalling

in numComId Number of datasets found in the conﬁguration

in pComIdDsIdMap Pointer to an array of structures of type TRDP_DATASET_T

in numDataSet Number of datasets found in the conﬁguration

in pDataset Pointer to an array of pointers to structures of type TRDP_DATASET_T

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

Generated by Doxygen

108 File Documentation

5.10.2.4 tau_marshall()

EXT_DECL TRDP_ERR_T tau_marshall (

void ∗pRefCon,

UINT32 comId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

marshall function.

Parameters

in pRefCon pointer to user context

in comId ComId to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_INIT_ERR marshalling not initialised

TRDP_COMID_ERR comid not existing

TRDP_PARAM_ERR Parameter error

Parameters

in pRefCon pointer to user context

in comId ComId to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_MARSHALLING_ERR dataset/source size mismatch

Generated by Doxygen

5.10 tau_marshall.h File Reference 109

5.10.2.5 tau_marshallDs()

EXT_DECL TRDP_ERR_T tau_marshallDs (

void ∗pRefCon,

UINT32 dsId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

marshall data set function.

Parameters

in pRefCon pointer to user context

in dsId Data set id to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_INIT_ERR marshalling not initialised

TRDP_COMID_ERR comid not existing

TRDP_PARAM_ERR Parameter error

Parameters

in pRefCon pointer to user context

in dsId Data set id to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

Generated by Doxygen

110 File Documentation

5.10.2.6 tau_unmarshall()

EXT_DECL TRDP_ERR_T tau_unmarshall (

void ∗pRefCon,

UINT32 comId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

unmarshall function.

Parameters

in pRefCon pointer to user context

in comId ComId to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_INIT_ERR marshalling not initialised

TRDP_COMID_ERR comid not existing

Parameters

in pRefCon pointer to user context

in comId ComId to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

Generated by Doxygen

5.10 tau_marshall.h File Reference 111

5.10.2.7 tau_unmarshallDs()

EXT_DECL TRDP_ERR_T tau_unmarshallDs (

void ∗pRefCon,

UINT32 dsId,

UINT8 ∗pSrc,

UINT32 srcSize,

UINT8 ∗pDest,

UINT32 ∗pDestSize,

TRDP_DATASET_T ∗∗ ppDSPointer )

unmarshall data set function.

Parameters

in pRefCon pointer to user context

in dsId Data set id to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_INIT_ERR marshalling not initialised

TRDP_COMID_ERR comid not existing

Parameters

in pRefCon pointer to user context

in dsId Data set id to identify the structure out of a conﬁguration

in pSrc pointer to received original message

in srcSize size of the source buffer

in pDest pointer to a buffer for the treated message

in,out pDestSize size of the provide buffer / size of the treated message

in,out ppDSPointer pointer to pointer to cached dataset set NULL if not used, set content NULL if unknown

Return values

TRDP_INIT_ERR marshalling not initialised

TRDP_NO_ERR no error

TRDP_MEM_ERR provided buffer to small

TRDP_PARAM_ERR Parameter error

TRDP_STATE_ERR Too deep recursion

TRDP_COMID_ERR comid not existing

TRDP_MARSHALLING_ERR dataset/source size mismatch

Generated by Doxygen

112 File Documentation

5.11 tau_tti.c File Reference

Functions for train topology information access.

#include <string.h>

#include <stdio.h>

#include "trdp_if_light.h"

#include "trdp_utils.h"

#include "tau_marshall.h"

#include "tau_tti.h"

#include "vos_sock.h"

#include "tau_dnr.h"

#include "tau_cstinfo.c"

Include dependency graph for tau_tti.c:

tau_tti.c

string.h

stdio.h

trdp_if_light.h

vos_sock.h

trdp_utils.h

tau_marshall.h

tau_tti.h

tau_dnr.htau_cstinfo.c

trdp_types.h

vos_types.h

vos_mem.h iec61375-2-3.h

stdint.h

vos_thread.hvos_private.h

trdp_private.hvos_utils.h

stddef.h

tau_tti_types.h

Macros

• #deﬁne TTI_CACHED_CONSISTS 8u

We hold this number of consist infos (ca.

Functions

• EXT_DECL TRDP_ERR_T tau_initTTIaccess (TRDP_APP_SESSION_T appHandle, VOS_SEMA_T user←-

Action, TRDP_IP_ADDR_T ecspIpAddr, CHAR8 ∗hostsFileName)

Function to init TTI access.

• EXT_DECL void tau_deInitTTI (TRDP_APP_SESSION_T appHandle)

Release any resources allocated by TTI Must be called before closing the session.

• EXT_DECL TRDP_ERR_T tau_getOpTrDirectory (TRDP_APP_SESSION_T appHandle, TRDP_OP_TRA←-

IN_DIR_STATE_T ∗pOpTrnDirState, TRDP_OP_TRAIN_DIR_T ∗pOpTrnDir)

Function to retrieve the operational train directory state.

Generated by Doxygen

5.11 tau_tti.c File Reference 113

• EXT_DECL TRDP_ERR_T tau_getOpTrnDirectoryStatusInfo (TRDP_APP_SESSION_T appHandle, TRD←-

P_OP_TRAIN_DIR_STATUS_INFO_T ∗pOpTrnDirStatusInfo)

Function to retrieve the operational train directory state info.

• EXT_DECL TRDP_ERR_T tau_getTrDirectory (TRDP_APP_SESSION_T appHandle, TRDP_TRAIN_DIR←-

_T ∗pTrnDir)

Function to retrieve the train directory.

• EXT_DECL TRDP_ERR_T tau_getStaticCstInfo (TRDP_APP_SESSION_T appHandle, TRDP_CONSIST←-

_INFO_T ∗pCstInfo, TRDP_UUID_T const cstUUID)

Function to retrieve the consist info.

• EXT_DECL TRDP_ERR_T tau_getTTI (TRDP_APP_SESSION_T appHandle, TRDP_OP_TRAIN_DIR_S←-

TATE_T ∗pOpTrnDirState, TRDP_OP_TRAIN_DIR_T ∗pOpTrnDir, TRDP_TRAIN_DIR_T ∗pTrnDir, TRDP←-

_TRAIN_NET_DIR_T ∗pTrnNetDir)

Function to retrieve the operational train directory.

• EXT_DECL TRDP_ERR_T tau_getTrnCstCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pTrnCstCnt)

Function to retrieve the total number of consists in the train.

• EXT_DECL TRDP_ERR_T tau_getTrnVehCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pTrnVehCnt)

Function to retrieve the total number of vehicles in the train.

• EXT_DECL TRDP_ERR_T tau_getCstVehCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pCstVehCnt,

const TRDP_LABEL_T pCstLabel)

Function to retrieve the total number of vehicles in a consist.

• EXT_DECL TRDP_ERR_T tau_getCstFctCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pCstFctCnt,

const TRDP_LABEL_T pCstLabel)

Function to retrieve the total number of functions in a consist.

• EXT_DECL TRDP_ERR_T tau_getCstFctInfo (TRDP_APP_SESSION_T appHandle, TRDP_FUNCTION_←-

INFO_T ∗pFctInfo, const TRDP_LABEL_T pCstLabel, UINT16 maxFctCnt)

Function to retrieve the function information of the consist.

• EXT_DECL TRDP_ERR_T tau_getVehInfo (TRDP_APP_SESSION_T appHandle, TRDP_VEHICLE_INF←-

O_T ∗pVehInfo, const TRDP_LABEL_T pVehLabel, const TRDP_LABEL_T pCstLabel)

Function to retrieve the vehicle information of a consist's vehicle.

• EXT_DECL TRDP_ERR_T tau_getCstInfo (TRDP_APP_SESSION_T appHandle, TRDP_CONSIST_INF←-

O_T ∗pCstInfo, const TRDP_LABEL_T pCstLabel)

Function to retrieve the consist information of a train's consist.

• EXT_DECL TRDP_ERR_T tau_getVehOrient (TRDP_APP_SESSION_T appHandle, UINT8 ∗pVehOrient,

UINT8 ∗pCstOrient, TRDP_LABEL_T pVehLabel, TRDP_LABEL_T pCstLabel)

Function to retrieve the orientation of the given vehicle.

• EXT_DECL TRDP_ERR_T tau_getOwnIds (TRDP_APP_SESSION_T appHandle, TRDP_LABEL_T ∗p←-

DevId, TRDP_LABEL_T ∗pVehId, TRDP_LABEL_T ∗pCstId)

Who am I ?.

5.11.1 Detailed Description

Functions for train topology information access.

The TTI subsystem maintains a pointer to the TAU_TTDB struct in the TRDP session struct. That TAU_TTDB

struct keeps the subscription and listener handles, the current TTDB directories and a pointer list to consist infos

(in network format). On init, most TTDB data is requested from the ECSP plus the own consist info. This data

is automatically updated if an inauguration is detected. Additional consist infos are requested on demand, only.

Because of the asynchronous behavior of the TTI subsystem, most functions in tau_tti.c may return TRDP_N←-

ODATA_ERR on ﬁrst invocation. They should be called again after 1...3 seconds (3s is the timeout for most MD

replies).

Generated by Doxygen

114 File Documentation

Note

Project: TCNOpen TRDP prototype stack

Author

B. Loehr (initial version)

Remarks

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL

was not distributed with this ﬁle, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright

tau_tti.c 1755 2018-08-07 12:10:03Z bloehr

BL 2018-08-07: Ticket #183 tau_getOwnIds declared but not defined

BL 2018-06-20: Ticket #184: Building with VS 2015: WIN64 and Windows threads (SOCKET instead of INT32)

BL 2017-11-28: Ticket #180 Filtering rules for DestinationURI does not follow the standard

BL 2017-11-13: Ticket #176 TRDP_LABEL_T breaks field alignment -> TRDP_NET_LABEL_T

AHW 2017-11-08: Ticket #179 Max. number of retries (part of sendParam) of a MD request needs to be checked

BL 2017-05-08: Compiler warnings, doxygen comment errors

BL 2017-04-28: Ticket #155: Kill trdp_proto.h - move definitions to iec61375-2-3.h

BL 2017-03-13: Ticket #154 ComIds and DSIds literals (#define TRDP_...) in trdp_proto.h too long

BL 2017-02-10: Ticket #129 Found a bug which yields wrong output params and potentially segfaults

BL 2017-02-08: Ticket #142 Compiler warnings / MISRA-C 2012 issues

BL 2016-02-18: Ticket #7: Add train topology information support

5.11.2 Macro Deﬁnition Documentation

5.11.2.1 TTI_CACHED_CONSISTS

#define TTI_CACHED_CONSISTS 8u

We hold this number of consist infos (ca.

105kB)

5.11.3 Function Documentation

5.11.3.1 tau_deInitTTI()

EXT_DECL void tau_deInitTTI (

TRDP_APP_SESSION_T appHandle )

Release any resources allocated by TTI Must be called before closing the session.

Function to terminate TTI access.

Generated by Doxygen

5.11 tau_tti.c File Reference 115

Parameters

in appHandle Handle returned by tlc_openSession().

Return values

none

5.11.3.2 tau_getCstFctCnt()

EXT_DECL TRDP_ERR_T tau_getCstFctCnt (

TRDP_APP_SESSION_T appHandle,

UINT16 ∗pCstFctCnt,

const TRDP_LABEL_T pCstLabel )

Function to retrieve the total number of functions in a consist.

Parameters

in appHandle Handle returned by tlc_openSession().

out pCstFctCnt Pointer to the number of functions to be returned

in pCstLabel Pointer to a consist label. NULL means own consist.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.11.3.3 tau_getCstFctInfo()

EXT_DECL TRDP_ERR_T tau_getCstFctInfo (

TRDP_APP_SESSION_T appHandle,

TRDP_FUNCTION_INFO_T ∗pFctInfo,

const TRDP_LABEL_T pCstLabel,

UINT16 maxFctCnt )

Function to retrieve the function information of the consist.

Parameters

in appHandle Handle returned by tlc_openSession().

out pFctInfo Pointer to function info list to be returned. Memory needs to be provided by application.

Set NULL if not used.

in pCstLabel Pointer to a consist label. NULL means own consist.

in maxFctCnt Maximal number of functions to be returned in provided buffer.

Generated by Doxygen

116 File Documentation

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.11.3.4 tau_getCstInfo()

EXT_DECL TRDP_ERR_T tau_getCstInfo (

TRDP_APP_SESSION_T appHandle,

TRDP_CONSIST_INFO_T ∗pCstInfo,

const TRDP_LABEL_T pCstLabel )

Function to retrieve the consist information of a train's consist.

Parameters

in appHandle Handle returned by tlc_openSession().

out pCstInfo Pointer to the consist info to be returned.

in pCstLabel Pointer to a consist label. NULL means own consist.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.11.3.5 tau_getCstVehCnt()

EXT_DECL TRDP_ERR_T tau_getCstVehCnt (

TRDP_APP_SESSION_T appHandle,

UINT16 ∗pCstVehCnt,

const TRDP_LABEL_T pCstLabel )

Function to retrieve the total number of vehicles in a consist.

Parameters

in appHandle Handle returned by tlc_openSession().

out pCstVehCnt Pointer to the number of vehicles to be returned

in pCstLabel Pointer to a consist label. NULL means own consist.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_NODATA_ERR Try again

Generated by Doxygen

5.11 tau_tti.c File Reference 117

5.11.3.6 tau_getOpTrDirectory()

EXT_DECL TRDP_ERR_T tau_getOpTrDirectory (

TRDP_APP_SESSION_T appHandle,

TRDP_OP_TRAIN_DIR_STATE_T ∗pOpTrnDirState,

TRDP_OP_TRAIN_DIR_T ∗pOpTrnDir )

Function to retrieve the operational train directory state.

Parameters

in appHandle Handle returned by tlc_openSession().

out pOpTrnDirState Pointer to an operational train directory state structure to be returned.

out pOpTrnDir Pointer to an operational train directory structure to be returned.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_NODATA_ERR Data currently not available, try again later

5.11.3.7 tau_getOpTrnDirectoryStatusInfo()

EXT_DECL TRDP_ERR_T tau_getOpTrnDirectoryStatusInfo (

TRDP_APP_SESSION_T appHandle,

TRDP_OP_TRAIN_DIR_STATUS_INFO_T ∗pOpTrnDirStatusInfo )

Function to retrieve the operational train directory state info.

Return a copy of the last received PD 100 telegram. Note: The values are in host endianess! When validating

(SDTv2), network endianess must be ensured.

Parameters

in appHandle Handle returned by tlc_openSession().

out pOpTrnDirStatusInfo Pointer to an operational train directory state structure to be returned.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

Generated by Doxygen

118 File Documentation

5.11.3.8 tau_getOwnIds()

EXT_DECL TRDP_ERR_T tau_getOwnIds (

TRDP_APP_SESSION_T appHandle,

TRDP_LABEL_T ∗pDevId,

TRDP_LABEL_T ∗pVehId,

TRDP_LABEL_T ∗pCstId )

Who am I ?.

Realizes a kind of 'Who am I' function. It is used to determine the own identiﬁers (i.e. the own labels), which may

be used as host part of the own fully qualiﬁed domain name.

Parameters

in appHandle Handle returned by tlc_openSession()

out pDevId Returns the device label (host name)

out pVehId Returns the vehicle label

out pCstId Returns the consist label

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_NODATA_ERR Data currently not available, call again

5.11.3.9 tau_getStaticCstInfo()

EXT_DECL TRDP_ERR_T tau_getStaticCstInfo (

TRDP_APP_SESSION_T appHandle,

TRDP_CONSIST_INFO_T ∗pCstInfo,

TRDP_UUID_T const cstUUID )

Function to retrieve the consist info.

Function to retrieve the operational train directory.

Parameters

in appHandle Handle returned by tlc_openSession().

out pCstInfo Pointer to a consist info structure to be returned.

in cstUUID UUID of the consist the consist info is rquested for.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

Generated by Doxygen

5.11 tau_tti.c File Reference 119

5.11.3.10 tau_getTrDirectory()

EXT_DECL TRDP_ERR_T tau_getTrDirectory (

TRDP_APP_SESSION_T appHandle,

TRDP_TRAIN_DIR_T ∗pTrnDir )

Function to retrieve the train directory.

Function to retrieve the operational train directory.

Parameters

in appHandle Handle returned by tlc_openSession().

out pTrnDir Pointer to a train directory structure to be returned.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_NODATA_ERR Try later

5.11.3.11 tau_getTrnCstCnt()

EXT_DECL TRDP_ERR_T tau_getTrnCstCnt (

TRDP_APP_SESSION_T appHandle,

UINT16 ∗pTrnCstCnt )

Function to retrieve the total number of consists in the train.

Parameters

in appHandle Handle returned by tlc_openSession().

out pTrnCstCnt Pointer to the number of consists to be returned

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_NODATA_ERR Try again

5.11.3.12 tau_getTrnVehCnt()

EXT_DECL TRDP_ERR_T tau_getTrnVehCnt (

TRDP_APP_SESSION_T appHandle,

UINT16 ∗pTrnVehCnt )

Function to retrieve the total number of vehicles in the train.

Generated by Doxygen

120 File Documentation

Parameters

in appHandle Handle returned by tlc_openSession().

out pTrnVehCnt Pointer to the number of vehicles to be returned

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

TRDP_NODATA_ERR Try again

5.11.3.13 tau_getTTI()

EXT_DECL TRDP_ERR_T tau_getTTI (

TRDP_APP_SESSION_T appHandle,

TRDP_OP_TRAIN_DIR_STATE_T ∗pOpTrnDirState,

TRDP_OP_TRAIN_DIR_T ∗pOpTrnDir,

TRDP_TRAIN_DIR_T ∗pTrnDir,

TRDP_TRAIN_NET_DIR_T ∗pTrnNetDir )

Function to retrieve the operational train directory.

Parameters

in appHandle Handle returned by tlc_openSession().

out pOpTrnDirState Pointer to an operational train directory state structure to be returned.

out pOpTrnDir Pointer to an operational train directory structure to be returned.

out pTrnDir Pointer to a train directory structure to be returned.

out pTrnNetDir Pointer to a train network directory structure to be returned.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.11.3.14 tau_getVehInfo()

EXT_DECL TRDP_ERR_T tau_getVehInfo (

TRDP_APP_SESSION_T appHandle,

TRDP_VEHICLE_INFO_T ∗pVehInfo,

const TRDP_LABEL_T pVehLabel,

const TRDP_LABEL_T pCstLabel )

Function to retrieve the vehicle information of a consist's vehicle.

Generated by Doxygen

5.11 tau_tti.c File Reference 121

Parameters

in appHandle Handle returned by tlc_openSession().

out pVehInfo Pointer to the vehicle info to be returned.

in pVehLabel Pointer to a vehicle label. NULL means own vehicle if cstLabel refers to own consist.

in pCstLabel Pointer to a consist label. NULL means own consist.

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.11.3.15 tau_getVehOrient()

EXT_DECL TRDP_ERR_T tau_getVehOrient (

TRDP_APP_SESSION_T appHandle,

UINT8 ∗pVehOrient,

UINT8 ∗pCstOrient,

TRDP_LABEL_T pVehLabel,

TRDP_LABEL_T pCstLabel )

Function to retrieve the orientation of the given vehicle.

Parameters

in appHandle Handle returned by tlc_openSession().

out pVehOrient Pointer to the vehicle orientation to be returned '00'B = not known (corrected vehicle)

'01'B = same as operational train direction '10'B = inverse to operational train direction

out pCstOrient Pointer to the consist orientation to be returned '00'B = not known (corrected vehicle)

'01'B = same as operational train direction '10'B = inverse to operational train direction

in pVehLabel vehLabel = NULL means own vehicle if cstLabel == NULL, currently ignored.

in pCstLabel cstLabel = NULL means own consist

Return values

TRDP_NO_ERR no error

TRDP_PARAM_ERR Parameter error

5.11.3.16 tau_initTTIaccess()

EXT_DECL TRDP_ERR_T tau_initTTIaccess (

TRDP_APP_SESSION_T appHandle,

VOS_SEMA_T userAction,

TRDP_IP_ADDR_T ecspIpAddr,

CHAR8 ∗hostsFileName )

Generated by Doxygen

122 File Documentation

Function to init TTI access.

Subscribe to necessary process data for correct ECSP handling, further calls need DNS!

Generated by Doxygen

5.12 tau_tti.h File Reference 123

Parameters

in appHandle Handle returned by tlc_openSession().

in userAction Semaphore to ﬁre if inauguration took place.

in ecspIpAddr ECSP IP address. Currently not used.

in hostsFileName Optional host ﬁle name as ECSP replacement. Currently not implemented.

Return values

TRDP_NO_ERR no error

TRDP_INIT_ERR initialisation error

5.12 tau_tti.h File Reference

TRDP utility interface deﬁnitions.

#include "trdp_types.h"

#include "tau_tti_types.h"

Generated by Doxygen

124 File Documentation

Include dependency graph for tau_tti.h:

tau_tti.h

trdp_types.h

tau_tti_types.h

vos_types.h

vos_mem.h vos_sock.h iec61375-2-3.h

stdint.h

vos_thread.h vos_private.h

Generated by Doxygen

5.12 tau_tti.h File Reference 125

This graph shows which ﬁles directly or indirectly include this ﬁle:

tau_tti.h

tau_ctrl.h

tau_ctrl_types.h tau_cstinfo.c

tau_tti.c

tau_dnr.c

tau_ctrl.c

Functions

• EXT_DECL TRDP_ERR_T tau_initTTIaccess (TRDP_APP_SESSION_T appHandle, VOS_SEMA_T user←-

Action, TRDP_IP_ADDR_T ecspIpAddr, CHAR8 ∗hostsFileName)

Function to init TTI access.

• EXT_DECL void tau_deInitTTI (TRDP_APP_SESSION_T appHandle)

Function to terminate TTI access.

• EXT_DECL TRDP_ERR_T tau_getOpTrDirectory (TRDP_APP_SESSION_T appHandle, TRDP_OP_TRA←-

IN_DIR_STATE_T ∗pOpTrDirState, TRDP_OP_TRAIN_DIR_T ∗pOpTrDir)

Function to retrieve the operational train directory state.

• EXT_DECL TRDP_ERR_T tau_getOpTrnDirectoryStatusInfo (TRDP_APP_SESSION_T appHandle, TRD←-

P_OP_TRAIN_DIR_STATUS_INFO_T ∗pOpTrnDirStatusInfo)

Function to retrieve the operational train directory state info.

• EXT_DECL TRDP_ERR_T tau_getTrDirectory (TRDP_APP_SESSION_T appHandle, TRDP_TRAIN_DIR←-

_T ∗pTrDir)

Function to retrieve the operational train directory.

• EXT_DECL TRDP_ERR_T tau_getStaticCstInfo (TRDP_APP_SESSION_T appHandle, TRDP_CONSIST←-

_INFO_T ∗pCstInfo, TRDP_UUID_T const cstUUID)

Function to retrieve the operational train directory.

• EXT_DECL TRDP_ERR_T tau_getTTI (TRDP_APP_SESSION_T appHandle, TRDP_OP_TRAIN_DIR_S←-

TATE_T ∗pOpTrnDirState, TRDP_OP_TRAIN_DIR_T ∗pOpTrnDir, TRDP_TRAIN_DIR_T ∗pTrnDir, TRDP←-

_TRAIN_NET_DIR_T ∗pTrnNetDir)

Function to retrieve the operational train directory.

• EXT_DECL TRDP_ERR_T tau_getTrnCstCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pTrnCstCnt)

Function to retrieve the total number of consists in the train.

• EXT_DECL TRDP_ERR_T tau_getTrnVehCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pTrnVehCnt)

Function to retrieve the total number of vehicles in the train.

• EXT_DECL TRDP_ERR_T tau_getCstVehCnt (TRDP_APP_SESSION_T appHandle, UINT16 ∗pCstVehCnt,

const TRDP_LABEL_T pCstLabel)

Function to retrieve the total number of vehicles in a consist.

Generated by Doxygen

126 File Documentation