package com.alibaba.otter.canal.protocol

Get desktop application:
View/edit binary Protocol Buffers messages

• oneof error_code_present

  [default = 0]

  • int32 error_code = 1

• string error_message = 2

  if something like compression is not supported, erorr_message will tell about it.

• string destination = 1

• string client_id = 2

• int64 batch_id = 3

client authentication

• string username = 1

• bytes password = 2

  hashed password with seeds from Handshake message

• oneof net_read_timeout_present

  [default = 0]

  • int32 net_read_timeout = 3

    in seconds

• oneof net_write_timeout_present

  [default = 0];

  • int32 net_write_timeout = 4

    in seconds

• string destination = 5

• string client_id = 6

• string filter = 7

• int64 start_timestamp = 8

• string destination = 1

• string client_id = 2

• int64 batch_id = 3

Used in: Handshake, Packet

• COMPRESSIONCOMPATIBLEPROTO2 = 0

• NONE = 1

• ZLIB = 2

• GZIP = 3

• LZF = 4

TBD when new packets are required

• string journal = 1

• int64 position = 2

• oneof timestamp_present

  [default = 0]

  • int64 timestamp = 3

PullRequest

• string destination = 1

• string client_id = 2

• int32 fetch_size = 3

• oneof timeout_present

  [default = -1]

  • int64 timeout = 4

    默认-1时代表不控制

• oneof unit_present

  [default = 2]

  • int32 unit = 5

    数字类型，0:纳秒,1:毫秒,2:微秒,3:秒,4:分钟,5:小时,6:天

• oneof auto_ack_present

  [default = false]

  • bool auto_ack = 6

    是否自动ack

• oneof communication_encoding_present

  [default = "utf8"];

  • string communication_encoding = 1

• bytes seeds = 2

• Compression supported_compressions = 3

• int64 send_timestamp = 1

• int64 start_timestamp = 2

• int64 batch_id = 1

• repeated bytes messages = 2

• oneof magic_number_present

  [default = 17];

  • int32 magic_number = 1

• oneof version_present

  [default = 1];

  • int32 version = 2

• PacketType type = 3

• oneof compression_present

  [default = NONE];

  • Compression compression = 4

• bytes body = 5

Used in: Packet

• PACKAGETYPECOMPATIBLEPROTO2 = 0

  compatible

• HANDSHAKE = 1

• CLIENTAUTHENTICATION = 2

• ACK = 3

• SUBSCRIPTION = 4

• UNSUBSCRIPTION = 5

• GET = 6

• MESSAGES = 7

• CLIENTACK = 8

• SHUTDOWN = 9

  management part

• DUMP = 10

  integration

• HEARTBEAT = 11

• CLIENTROLLBACK = 12

subscription

• string destination = 1

• string client_id = 2

• string filter = 7

Unsubscription

• string destination = 1

• string client_id = 2

• string filter = 7