tarsdocs
  • Readme.md
  • CLA
  • LICENSE
  • 基础介绍
    • 简介
    • 基础概念
    • 基础通信协议 Tars
    • 统一通信协议 Tup
    • 开发模式介绍
    • 模板配置
    • 服务市场
    • 服务扩展
    • 框架版本说明
  • 开源版框架介绍
    • 开源版本部署
      • 部署总体介绍
      • Docker环境安装
      • Mysql安装
      • 框架源码部署(Linux/Mac)
      • 框架源码部署(Windows)
      • 框架Docker部署
      • 框架节点部署
      • 业务服务容器化
      • 框架K8SDocker 部署
      • 框架K8STARS 部署
      • 框架K8SFramework 部署(强烈推荐)
      • 框架更新及扩容
      • 调用链升级注意事项
      • TarsWeb-v3.0.3升级说明
    • 开源版管理平台
      • TarsWeb说明
      • web用户体系
      • web管理平台 API
  • 企业版本介绍
    • 企业版说明
    • 框架集群化机制
    • 框架单节点机制
    • 使用二进制包部署
    • 使用容器部署
    • 业务服务一主多备机制
    • 命令行控制终端
    • IP-LIST级联缓存机制
    • 多数据中心管理
    • 多网络支持
    • 第三方服务管理
    • 数据产生和管理机制
    • 密码重置
    • TarsPython介绍
  • 框架关键特性
    • 业务配置
    • 服务监控
    • 无损发布/重启
    • 调用链
    • IDC分组
    • 鉴权功能
  • TarsCPP
    • 编译
    • 快速开发入门
    • 使用指南
    • 开发规范
    • 服务线程说明文档
    • protobuf 协议支持文档
    • 第三方协议支持
    • HTTP1 支持
    • HTTP2 支持
    • TLS 通信支持
    • Push 功能说明
    • PushCallback 功能说明
    • Cookie 支持
    • 队列模式
    • 手动绑定
    • 性能数据
    • 2.x 版本变化
    • 3.x 版本变化
    • 协程版本说明
    • 基础类库说明
    • [案例]
      • 框架快速入门
      • Http 服务示例
  • TarsJava
    • 快速开始
    • 快速开发入门
    • [使用指南]
      • Tars 服务开发与上线
      • HTTP 服务开发与上线
      • 生成接口调用文件
    • [性能测试]
      • tars java 压测代码
  • TarsGo
    • 基本介绍
    • 快速开始
    • 使用指南
    • cmake 管理代码
    • pb2tarsgo
    • 性能数据
    • 使用示例
  • TarsPHP
    • 搭建 php 环境
    • 快速开发入门
    • [快速起步]
      • 搭建 HttpServer
      • 搭建 TimerServer
      • 搭建 TcpServer
      • 搭建 WebSocketServer
      • 弹幕活动实战
    • [框架简介]
      • 简介
      • tars-server
      • tars-client
      • tars-config
      • tars-deploy
      • tars-extension
      • tars-log
      • tars-monitor
      • tars-registry
      • tars-report
      • tars-utils
      • tars2php
    • [高阶应用]
      • PHP 的 Swoole 框架如何接入 Tars
      • 与 thinkphp 结合使用
      • 与 Swoft 结合使用
      • 与 Laravel 结合使用
      • 与 Yii2 结合使用
      • 持续集成方案
    • [其他]
      • 常见问题
      • 如何 Debug
      • changelog
      • 其他外部文档
  • Tars.js
    • 基本介绍
    • 脚手架
    • 快速开发入门
    • @tars/stream
    • @tars/rpc
    • @tars/logs
    • @tars/config
    • @tars/monitor
    • @tars/notify
    • @tars/utils
    • @tars/dyeing
    • @tars/node-agent
    • @tars/winston-tars
    • tars2node
  • K8SFramework
    • [安装和使用说明]
      • 介绍
      • 特性
      • 安装
      • 升级
      • 云原生运维
      • 管理平台
      • 证书
    • [开发环境构建]
      • Dockerfile 说明
      • 服务发布流程说明
      • 制作基础编译镜像
      • 制作业务服务镜像
      • 制作 Helm 包
      • 发布业务镜像到 K8S 集群
      • 服务发布示例
      • 如何调试业务服务
  • 服务扩展
    • 云告警
    • 接口及压测工具
    • 网关服务
    • dcache缓存服务
    • 发送邮件服务
    • 一致性存储服务
    • 一致性存储web管理平台
    • 唯一计数服务
  • 常见问题
    • 安装常见问题
    • Issues
    • Issues-tarscpp
    • Issues-tarsjava
    • Issues-tarsgo
    • Issues-tarsphp
  • 开源合作
    • TarsFramework 项目 Git 合作规范
  • 直播视频
    • B 站 TARS 培训系列课程
  • 相关文章
    • TARS 技术文章
  • 其它资源分享
    • 下载
    • Tars 介绍.pptx
    • TarsPHP 解密.pdf
    • TarsJava 本地调试.pdf
    • 微服务在腾讯的业务实践.pptx
Powered by GitBook
On this page
  • 背景
  • 接口定义
  • 其他说明

Was this helpful?

  1. TarsCPP

PushCallback 功能说明

相对于普通的push, 使用者需要自己编解码协议, 本文介绍tarscpp中另外一种push callback的方式, 这种方式可以大幅度降低服务间push的开发难度.

背景

当服务A和服务B间有交互, 当A主动发起连接B, 此时A作为客户端, B作为服务端, 当B希望主动给A push消息时, 我们可以采取tarscpp中的第三方协议来完成, 但是这种模式下, 主要有两个缺点:

服务的协议完全自定义的, 提高了开发难度 服务协议非普通的tars协议, 如果一个普通的tars协议服务希望具备这个功能就比较难做到 因此tarscpp框架提供了一种全新的push callback模式来解决这两个问题.

接口定义

我们先看看具体的使用案例, 首先定义服务B的接口如下:

interface Hello
{
    int registerPush();
};

可以看到这个接口比较简单, 就是提供A调用, 用于注册push.

在定义服务A和B之间的push接口, 这个定义非常重要, 是整个push callback的精髓, 需要仔细理解.

interface Push
{
    int pushMsg(out string sRsp);
};

服务端实现

完成接口定义后, 我们再来看服务B的核心实现, 首先服务B在Hello的实现中, 实现registerPush, 头文件HelloImp核心定义如下:

 /**
  * 连接关闭
  * @param current 
  * @return 
  */
 virtual int doClose(tars::TarsCurrentPtr current);

  /**
   * 客户端请求注册push通知
   */
  virtual int registerPush(tars::TarsCurrentPtr current);

实现文件如下:

int HelloImp::doClose(tars::TarsCurrentPtr current)
{
   g_app._pushThread.delCurrent(current);
}
int HelloImp::registerPush(tars::TarsCurrentPtr current)
{
   g_app._pushThread.addCurrent(current);
    return 0;
}

说明:

  • push是个长连接,需要关注连接关闭事件, 因此可以看到实现了doClose方法, 将current去掉;

  • 而registerPush是服务A主动调用, 此时服务B将current保存起来, 用于后续push;

  • current表示了请求的上下文, 如果是同一个连接上来的请求, current->getUId()的值相同的, 框架层也是利用这个Id给对应的连接回消息

  • _pushThread是一个自己实现的push线程类, 这个你可以根据实际情况去实现

接下来我们看看_pushThread 到底做了哪些工作.

_pushThread是自己实现的一个对象, 由于示例比较简单, 它会启动一个线程然后使用保存下来的current给上来的请求发送push消息, 核心示例代码如下:

void PushThread::addCurrent(CurrentPtr &current)
{
 std::lock_guard<std::mutex> lock(_mutex);

 _currents[current->getUId()] = current;
}

void PushThread::delCurrent(CurrentPtr &current)
{
 std::lock_guard<std::mutex> lock(_mutex);

 _currents.erase(current->getUId());
}

void PushThread::run()
{
 while(!_terminate)
 {
  std::unique_lock<std::mutex> lock(_mutex);

  for(auto it : _currents)
  {
   TestApp::Push::async_response_push_pushMsg(it.second, 0, "push message");
  }

  _cond.wait_for(lock, std::chrono::milliseconds(1000));
 }

}

其中最核心的一行代码:

TestApp::Push::async_response_push_pushMsg(it.second, 0, "push message");

分析:

  • async_response_push_pushMsg函数是根据前面Push接口自动生成的, 匹配了Push接口的pushMsg函数

  • 第一参数是current, 代表了是哪个连接上来的, 第二个参数是pushMsg的返回值, 第三个参数是pushMsg的out返回参数, 可以有多个返回参数, 这种push方式, 不需要有输入参数.

可以看到利用这个方法就可以给客户端返回想要的数据.

  • 客户端实现 对于客户端而言, 获取服务端的通知也非常简单, 代码示例如下:

class PushCallbackImp : public PushPrxCallback
{
public:
 virtual void callback_pushMsg(tars::Int32 ret,  const std::string& sRsp)
 {
  LOG_CONSOLE_DEBUG << ret << ", " << sRsp << endl;
 }
};

_comm = new Communicator();

HelloPrx pPrx = _comm->stringToProxy<HelloPrx>(helloObj);
pPrx->tars_set_push_callback(new PushCallbackImp());
pPrx->registerPush();

分析:

  • 客户端为了收取push消息, 核心就是要注册tars_set_push_callback一个回调;

  • PushPrxCallback就是代码生成中的类, 实现对应的callback_pushMsg 即可完成push回调!

可以看到, 客户端的操作也非常简单!

其他说明

利用push callback机制, 可以非常方便完成服务间的push机制, 但是需要注意几点

  • registerPush可以定时调用, 保持A和B之间连接的活跃度

  • 需要注意B有多台服务器的场景, 每次调用registerPush都是轮训的, 这个时候就需要考虑清楚push机制该如何设计, 这个本文就不展开,使用者可以自己仔细思考一下

  • tarsgo也已经支持该模式, 其他语言暂时未实现该机制.

PreviousPush 功能说明NextCookie 支持

Last updated 1 year ago

Was this helpful?