session-ios/SignalServiceKit/protobuf/WebSocketResources.proto

51 lines
1.2 KiB
Protocol Buffer
Raw Normal View History

2018-05-18 19:55:22 +02:00
/**
* Copyright (C) 2014-2016 Open Whisper Systems
*
* Licensed according to the LICENSE file in this repository.
*/
2018-06-07 07:57:59 +02:00
// iOS - since we use a modern proto-compiler, we must specify
// the legacy proto format.
syntax = "proto2";
// iOS - package name determines class prefix
package WebSocketProtos;
2018-05-18 19:55:22 +02:00
option java_package = "org.whispersystems.signalservice.internal.websocket";
option java_outer_classname = "WebSocketProtos";
message WebSocketRequestMessage {
2018-08-03 20:03:02 +02:00
// @required
2018-05-18 19:55:22 +02:00
optional string verb = 1;
2018-08-03 20:03:02 +02:00
// @required
2018-05-18 19:55:22 +02:00
optional string path = 2;
optional bytes body = 3;
repeated string headers = 5;
2018-08-03 20:03:02 +02:00
// @required
optional uint64 requestId = 4;
2018-05-18 19:55:22 +02:00
}
message WebSocketResponseMessage {
2018-08-03 20:03:02 +02:00
// @required
optional uint64 requestId = 1;
2018-08-03 20:03:02 +02:00
// @required
2018-05-18 19:55:22 +02:00
optional uint32 status = 2;
optional string message = 3;
repeated string headers = 5;
2018-08-03 20:03:02 +02:00
// @required
2018-05-18 19:55:22 +02:00
optional bytes body = 4;
}
message WebSocketMessage {
2018-05-18 19:55:22 +02:00
enum Type {
UNKNOWN = 0;
REQUEST = 1;
RESPONSE = 2;
}
2018-08-03 20:03:02 +02:00
// @required
2018-05-18 19:55:22 +02:00
optional Type type = 1;
optional WebSocketRequestMessage request = 2;
optional WebSocketResponseMessage response = 3;
2018-06-07 07:57:59 +02:00
}