Documentation ¶
Overview ¶
Package api is a generated protocol buffer package.
It is generated from these files:
api/cast_channel.proto
It has these top-level messages:
CastMessage AuthChallenge AuthResponse AuthError DeviceAuthMessage
Index ¶
- Variables
- type AuthChallenge
- type AuthError
- type AuthError_ErrorType
- type AuthResponse
- type CastMessage
- func (m *CastMessage) GetDestinationId() string
- func (m *CastMessage) GetNamespace() string
- func (m *CastMessage) GetPayloadBinary() []byte
- func (m *CastMessage) GetPayloadType() CastMessage_PayloadType
- func (m *CastMessage) GetPayloadUtf8() string
- func (m *CastMessage) GetProtocolVersion() CastMessage_ProtocolVersion
- func (m *CastMessage) GetSourceId() string
- func (*CastMessage) ProtoMessage()
- func (m *CastMessage) Reset()
- func (m *CastMessage) String() string
- type CastMessage_PayloadType
- type CastMessage_ProtocolVersion
- type DeviceAuthMessage
Constants ¶
This section is empty.
Variables ¶
View Source
var AuthError_ErrorType_name = map[int32]string{
0: "INTERNAL_ERROR",
1: "NO_TLS",
}
View Source
var AuthError_ErrorType_value = map[string]int32{
"INTERNAL_ERROR": 0,
"NO_TLS": 1,
}
View Source
var CastMessage_PayloadType_name = map[int32]string{
0: "STRING",
1: "BINARY",
}
View Source
var CastMessage_PayloadType_value = map[string]int32{
"STRING": 0,
"BINARY": 1,
}
View Source
var CastMessage_ProtocolVersion_name = map[int32]string{
0: "CASTV2_1_0",
}
View Source
var CastMessage_ProtocolVersion_value = map[string]int32{
"CASTV2_1_0": 0,
}
Functions ¶
This section is empty.
Types ¶
type AuthChallenge ¶
type AuthChallenge struct {
XXX_unrecognized []byte `json:"-"`
}
Messages for authentication protocol between a sender and a receiver.
func (*AuthChallenge) ProtoMessage ¶
func (*AuthChallenge) ProtoMessage()
func (*AuthChallenge) Reset ¶
func (m *AuthChallenge) Reset()
func (*AuthChallenge) String ¶
func (m *AuthChallenge) String() string
type AuthError ¶
type AuthError struct { ErrorType *AuthError_ErrorType `protobuf:"varint,1,req,name=error_type,enum=api.AuthError_ErrorType" json:"error_type,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*AuthError) GetErrorType ¶
func (m *AuthError) GetErrorType() AuthError_ErrorType
func (*AuthError) ProtoMessage ¶
func (*AuthError) ProtoMessage()
type AuthError_ErrorType ¶
type AuthError_ErrorType int32
const ( AuthError_INTERNAL_ERROR AuthError_ErrorType = 0 AuthError_NO_TLS AuthError_ErrorType = 1 )
func (AuthError_ErrorType) Enum ¶
func (x AuthError_ErrorType) Enum() *AuthError_ErrorType
func (AuthError_ErrorType) String ¶
func (x AuthError_ErrorType) String() string
func (*AuthError_ErrorType) UnmarshalJSON ¶
func (x *AuthError_ErrorType) UnmarshalJSON(data []byte) error
type AuthResponse ¶
type AuthResponse struct { Signature []byte `protobuf:"bytes,1,req,name=signature" json:"signature,omitempty"` ClientAuthCertificate []byte `protobuf:"bytes,2,req,name=client_auth_certificate" json:"client_auth_certificate,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*AuthResponse) GetClientAuthCertificate ¶
func (m *AuthResponse) GetClientAuthCertificate() []byte
func (*AuthResponse) GetSignature ¶
func (m *AuthResponse) GetSignature() []byte
func (*AuthResponse) ProtoMessage ¶
func (*AuthResponse) ProtoMessage()
func (*AuthResponse) Reset ¶
func (m *AuthResponse) Reset()
func (*AuthResponse) String ¶
func (m *AuthResponse) String() string
type CastMessage ¶
type CastMessage struct { ProtocolVersion *CastMessage_ProtocolVersion `protobuf:"varint,1,req,name=protocol_version,enum=api.CastMessage_ProtocolVersion" json:"protocol_version,omitempty"` // source and destination ids identify the origin and destination of the // message. They are used to route messages between endpoints that share a // device-to-device channel. // // For messages between applications: // - The sender application id is a unique identifier generated on behalf of // the sender application. // - The receiver id is always the the session id for the application. // // For messages to or from the sender or receiver platform, the special ids // 'sender-0' and 'receiver-0' can be used. // // For messages intended for all endpoints using a given channel, the // wildcard destination_id '*' can be used. SourceId *string `protobuf:"bytes,2,req,name=source_id" json:"source_id,omitempty"` DestinationId *string `protobuf:"bytes,3,req,name=destination_id" json:"destination_id,omitempty"` // This is the core multiplexing key. All messages are sent on a namespace // and endpoints sharing a channel listen on one or more namespaces. The // namespace defines the protocol and semantics of the message. Namespace *string `protobuf:"bytes,4,req,name=namespace" json:"namespace,omitempty"` PayloadType *CastMessage_PayloadType `protobuf:"varint,5,req,name=payload_type,enum=api.CastMessage_PayloadType" json:"payload_type,omitempty"` // Depending on payload_type, exactly one of the following optional fields // will always be set. PayloadUtf8 *string `protobuf:"bytes,6,opt,name=payload_utf8" json:"payload_utf8,omitempty"` PayloadBinary []byte `protobuf:"bytes,7,opt,name=payload_binary" json:"payload_binary,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*CastMessage) GetDestinationId ¶
func (m *CastMessage) GetDestinationId() string
func (*CastMessage) GetNamespace ¶
func (m *CastMessage) GetNamespace() string
func (*CastMessage) GetPayloadBinary ¶
func (m *CastMessage) GetPayloadBinary() []byte
func (*CastMessage) GetPayloadType ¶
func (m *CastMessage) GetPayloadType() CastMessage_PayloadType
func (*CastMessage) GetPayloadUtf8 ¶
func (m *CastMessage) GetPayloadUtf8() string
func (*CastMessage) GetProtocolVersion ¶
func (m *CastMessage) GetProtocolVersion() CastMessage_ProtocolVersion
func (*CastMessage) GetSourceId ¶
func (m *CastMessage) GetSourceId() string
func (*CastMessage) ProtoMessage ¶
func (*CastMessage) ProtoMessage()
func (*CastMessage) Reset ¶
func (m *CastMessage) Reset()
func (*CastMessage) String ¶
func (m *CastMessage) String() string
type CastMessage_PayloadType ¶
type CastMessage_PayloadType int32
What type of data do we have in this message.
const ( CastMessage_STRING CastMessage_PayloadType = 0 CastMessage_BINARY CastMessage_PayloadType = 1 )
func (CastMessage_PayloadType) Enum ¶
func (x CastMessage_PayloadType) Enum() *CastMessage_PayloadType
func (CastMessage_PayloadType) String ¶
func (x CastMessage_PayloadType) String() string
func (*CastMessage_PayloadType) UnmarshalJSON ¶
func (x *CastMessage_PayloadType) UnmarshalJSON(data []byte) error
type CastMessage_ProtocolVersion ¶
type CastMessage_ProtocolVersion int32
Always pass a version of the protocol for future compatibility requirements.
const (
CastMessage_CASTV2_1_0 CastMessage_ProtocolVersion = 0
)
func (CastMessage_ProtocolVersion) Enum ¶
func (x CastMessage_ProtocolVersion) Enum() *CastMessage_ProtocolVersion
func (CastMessage_ProtocolVersion) String ¶
func (x CastMessage_ProtocolVersion) String() string
func (*CastMessage_ProtocolVersion) UnmarshalJSON ¶
func (x *CastMessage_ProtocolVersion) UnmarshalJSON(data []byte) error
type DeviceAuthMessage ¶
type DeviceAuthMessage struct { // Request fields Challenge *AuthChallenge `protobuf:"bytes,1,opt,name=challenge" json:"challenge,omitempty"` // Response fields Response *AuthResponse `protobuf:"bytes,2,opt,name=response" json:"response,omitempty"` Error *AuthError `protobuf:"bytes,3,opt,name=error" json:"error,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*DeviceAuthMessage) GetChallenge ¶
func (m *DeviceAuthMessage) GetChallenge() *AuthChallenge
func (*DeviceAuthMessage) GetError ¶
func (m *DeviceAuthMessage) GetError() *AuthError
func (*DeviceAuthMessage) GetResponse ¶
func (m *DeviceAuthMessage) GetResponse() *AuthResponse
func (*DeviceAuthMessage) ProtoMessage ¶
func (*DeviceAuthMessage) ProtoMessage()
func (*DeviceAuthMessage) Reset ¶
func (m *DeviceAuthMessage) Reset()
func (*DeviceAuthMessage) String ¶
func (m *DeviceAuthMessage) String() string
Click to show internal directories.
Click to hide internal directories.