package com.webank.ai.eggroll.api.networking.proxy

Get desktop application:
View/edit binary Protocol Buffers messages

data transfer service

• rpc push (stream Packet, Metadata)

  proxy.proto:106

• rpc pull (Metadata, stream Packet)

  proxy.proto:107

• rpc unaryCall (Packet, Packet)

  proxy.proto:108

• rpc polling (stream PollingFrame, stream PollingFrame)

  proxy.proto:109

  message PollingFrame

  proxy.proto:96

  • string method = 1

  • int64 seq = 2

  • optional Metadata metadata = 10

  • optional Packet packet = 20

  • string desc = 30

• rpc query (Topic, core.Endpoint)

  proxy.proto:113

task admin command

Used in: Metadata

• string name = 1

Used in: Metadata

• int64 overallTimeout = 1

  total timeout, in ms

• int64 completionWaitTimeout = 2

  timeout for waiting for complete, in ms

• int64 packetIntervalTimeout = 3

  timeout for packet interval, in ms

• int32 maxRetries = 4

includes key and value field, supporting sequential and random data transfer

Used in: Packet

• string key = 1

  compatible with list / dict

• bytes value = 2

  actual value

response of heartbeat

• optional Metadata header = 1

• Operation operation = 2

metadata used for network data transfer

Used as request type in: DataTransferService.pull

Used as response type in: DataTransferService.push

Used as field type in: HeartbeatResponse, Packet, PollingFrame

• optional Task task = 1

  task description

• optional Topic src = 2

  source topic

• optional Topic dst = 3

  destincation topic

• optional Command command = 4

  task managing command (if any)

• string operator = 5

  model operator

• int64 seq = 6

  stream seq (reserved)

• int64 ack = 7

  stream ack (reserved)

• optional Conf conf = 8

  operation config

• bytes ext = 9

• string version = 100

metadata of event

Used in: Task

• string name = 1

• string dataKey = 2

returned by service heartbeat to decide next operation

Used in: HeartbeatResponse

• START = 0

• RUN = 1

• STOP = 2

• KILL = 3

• GET_DATA = 4

• PUT_DATA = 5

data streaming packet

Used as request type in: DataTransferService.push, DataTransferService.unaryCall

Used as response type in: DataTransferService.pull, DataTransferService.unaryCall

Used as field type in: PollingFrame

• optional Metadata header = 1

  packet header

• optional Data body = 2

  packet body

metadata of task

Used in: Metadata

• string taskId = 1

• optional Model model = 2

Used as request type in: RouteService.query

Used as field type in: Metadata

• string name = 1

• string partyId = 2

• string role = 3

• optional core.Endpoint callback = 4

  implication of pub/sub model, necessary for http-based senario