Tmax Gateway Guide (TCP/IP)

Tmax v5.0 SP2 Fix #1

Restricted Rights Legend

All TmaxSoft Software (Tmax®) and documents are protected by copyright laws and international convention. TmaxSoft software and documents are made available under the terms of the TmaxSoft License Agreement and may only be used or copied in accordance with the terms of this agreement. No part of this document may be transmitted, copied, deployed, or reproduced in any form or by any means, electronic, mechanical, or optical, without the prior written consent of TmaxSoft Co., Ltd.

Nothing in this software document and agreement constitutes a transfer of intellectual property rights regardless of whether or not such rights are registered) or any rights to TmaxSoft trademarks, logos, or any other brand features.

This document is for information purposes only. The company assumes no direct or indirect responsibilities for the contents of this document, and does not guarantee that the information contained in this document satisfies certain legal or commercial conditions.

The information contained in this document is subject to change without prior notice due to product upgrades or updates. The company assumes no liability for any errors in this document.

Trademarks

Tmax®, Tmax WebtoB® and JEUS® are registered trademark of TmaxSoft Co., Ltd. Other products, titles or services may be registered trademarks of their respective companies.

Open Source Software Notice

Some modules or files of this product are subject to the terms of the following licenses: openssl-0.9.7.m, zlib-1.1.4, expat-2.0.0, netsnmp, DCE1.0, pthread, google-diff-match-patch, libevent, getopt.

Detailed Information related to the license can be found in the following directory: ${INSTALL_PATH}/license/oss_licenses.

Document Information

Document Name: Tmax Gateway Guide (TCP/IP)

Document Created: 2016-03-31

Software Version: Tmax v5.0 SP2 Fix #1

Document Version: v2.1.5.1


Table of Contents

About This Document
1. Overview
1.1. Overview
1.2. Service Types
1.2.1. Synchronous TCPGW
1.2.2. Asynchronous TCPGW
1.2.3. Server TCPGW
1.2.4. TCPGW Client
1.3. Other Gateway Functions
1.3.1. Gateway Header
1.3.2. Processing Multiple Replies
1.3.3. Service Name Search Order
1.3.4. User Specified Channel
1.3.5. Code Conversion
2. Environment Configuration
2.1. Overview
2.2. Tmax Environment Configuration
2.2.1. Server/Client TCPGW
2.2.2. Blocking Service
2.2.3. Non-Blocking Service
2.2.4. Remote Synchronous and Asynchronous TCPGW
2.2.5. TCPGW Reconnection
2.2.6. TCPGW Client Connections to Multiple Remote Nodes
2.3. User Header Environment Configuration
2.4. Channel Backup Configuration
2.5. Transmitting Data during Ping Message Checks
3. User Programs and Functions
3.1. Overview
3.2. custom.h
3.3. custom.c
3.3.1. init_remote_info
3.3.2. remote_connected
3.3.3. remote_connected_ipv6
3.3.4. remote_closed
3.3.5. allow_connection
3.3.6. allow_connection_ipv6
3.3.7. get_msg_length
3.3.8. get_msg_info
3.3.9. get_channel_num
3.3.10. put_msg_info
3.3.11. put_msg_complete
3.3.12. get_service_name
3.3.13. prepare_shutdown
3.3.14. set_service_timeout
3.3.15. chk_end_msg
3.3.16. inmsg_recovery
3.3.17. outmsg_recovery
3.3.18. get_extmsg_info
3.3.19. put_extmsg_info
3.3.20. set_ping_msg
3.3.21. chk_pong_msg
3.3.22. set_extping_msg
3.3.23. chk_extpong_msg
3.3.24. reset_ping_msg
3.3.25. reset_extping_msg
3.3.26. set_error_msg
3.3.27. get_msg_security
3.3.28. put_msg_security
3.4. register.c
4. Examples
4.1. OUTBOUND TCPGW
4.1.1. Environment File
4.1.2. TCPGW
4.1.3. Remote Node
4.1.4. Server
4.2. Synchronous INBOUND TCPGW
4.2.1. Environment File
4.2.2. TCPGW
4.2.3. Remote Node
4.2.4. Client
4.3. Non-blocking TCPGW
4.3.1. Environment File
4.3.2. TCPGW
4.3.3. Remote Node
4.3.4. Server
4.3.5. Client
A. TCPGW Error Codes
Index

List of Figures

[Figure 1.1] TCPGW Operation
[Figure 1.2] TCPGW Operation (Synchronous / Asynchronous)
[Figure 1.3] Synchronous TCPGW - Blocking Service
[Figure 1.4] Synchronous TCPGW - Non-blocking Service
[Figure 1.5] Synchronous TCPGW - Remote Method
[Figure 1.6] Asynchronous TCPGW - Requesting a Service from Tmax
[Figure 1.7] Asynchronous TCPGW - Requesting a Service from Remote
[Figure 1.8] TCPGW server Operation
[Figure 1.9] TCPGW Client Operation
[Figure 4.1] OUTBOUND TCPGW Program Operation
[Figure 4.2] Operation of Synchronous INBOUND TCPGW
[Figure 4.3] Non-blocking TCPGW Method