TarsCpp Documentation

TarsCpp is the C++ implementation of the Tars RPC framework. The repository is organized into several key functional areas:

• servant: The core source code implementation of the C++ RPC framework.
• tools: The implementation of the IDL (Interface Definition Language) tool for C++.
• util: Basic utility libraries used by the framework.
• examples: Sample code including quick start guides, promise-based programming examples, and pressure test programs.
• docs / docs-en: Documentation for the framework.

tarscpp is the C++ implementation of the Tars framework's RPC (Remote Procedure Call) system. It provides the core infrastructure for service communication, protocol handling, and asynchronous programming within the Tars ecosystem.

Key components include:

• wup: Implements the tars/wup uniform communication protocol and its codec.
• protocol: Defines the underlying communication return codes and the interfaces used to interact with the framework's underlying services.
• servant/libservant: The core source code implementation of the RPC framework.
• jmem: A memory data structure component implementation based on the Tars protocol.
• promise: An asynchronous programming implementation based on the Promise pattern.
• script: Tooling to automate the generation of TARS service template code.

The examples/ directory contains several demonstration projects designed to help developers learn different aspects of the TarsCpp framework. Depending on your goal, you can explore the following specific demos:

• QuickStartDemo: For a fast introduction to Tars development.
• PromiseDemo: Demonstrates asynchronous programming using the Promise pattern.
• HttpDemo: Shows how to implement an HTTP server.
• WebSocketServer: A WebSocketProtocol server example that includes a built-in browser testing page.
• CoroutineDemo: Demonstrates the use of coroutines within the framework.
• StressDemo: Provides code for performing stress tests on Tars C++ services.
• PushDemo: Demonstrates the Tars 'Push' mode (server-to-client communication).

The examples/CoroutineDemo directory contains sample code demonstrating how to use coroutines within the Tars framework. It is divided into two main functional areas:

1. Client-Server Interaction (client/BServer/AServer): Demonstrates a multi-tier architecture where a client accesses BServer, and BServer uses coroutines to perform both parallel and serial requests to AServer.
2. Custom Coroutine Implementation (testCoro/testParallelCoro): Demonstrates how to implement custom coroutine logic or extend the existing framework's coroutine classes.

The StressDemo project provides entry-level examples for learning how to use Tars. It consists of two primary components designed to demonstrate performance stress testing:

• TarsStressServer: A Tars-based server application designed to be the target of performance stress tests.
• TarsStressClient: A Tars-based client application designed to perform the stress testing against a server.

Use these examples to understand how to implement both service providers and performance-testing clients within the Tars framework.

The examples/CustomDemo directory contains reference implementations for getting started with Tars. It is divided into two primary functional examples:

• HelloServer: A basic implementation designed for rapid development onboarding and learning the core Tars service patterns.
• ProxyServer: An example of a middleware/proxy service that acts as a proxy for the HelloServer.