Documentation ¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterSignalingServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterSignalingServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SignalingServiceClient) error
- func RegisterSignalingServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterSignalingServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SignalingServiceServer) error
- func RegisterSignalingServiceServer(s grpc.ServiceRegistrar, srv SignalingServiceServer)
- type AnswerRequest
- func (*AnswerRequest) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerRequest) GetDone() *AnswerRequestDoneStage
- func (x *AnswerRequest) GetError() *AnswerRequestErrorStage
- func (x *AnswerRequest) GetHeartbeat() *AnswerRequestHeartbeatStage
- func (x *AnswerRequest) GetInit() *AnswerRequestInitStage
- func (m *AnswerRequest) GetStage() isAnswerRequest_Stage
- func (x *AnswerRequest) GetUpdate() *AnswerRequestUpdateStage
- func (x *AnswerRequest) GetUuid() string
- func (*AnswerRequest) ProtoMessage()
- func (x *AnswerRequest) ProtoReflect() protoreflect.Message
- func (x *AnswerRequest) Reset()
- func (x *AnswerRequest) String() string
- type AnswerRequestDoneStage
- type AnswerRequestErrorStage
- func (*AnswerRequestErrorStage) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerRequestErrorStage) GetStatus() *status.Status
- func (*AnswerRequestErrorStage) ProtoMessage()
- func (x *AnswerRequestErrorStage) ProtoReflect() protoreflect.Message
- func (x *AnswerRequestErrorStage) Reset()
- func (x *AnswerRequestErrorStage) String() string
- type AnswerRequestHeartbeatStage
- type AnswerRequestInitStage
- func (*AnswerRequestInitStage) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerRequestInitStage) GetDeadline() *timestamppb.Timestamp
- func (x *AnswerRequestInitStage) GetOptionalConfig() *WebRTCConfig
- func (x *AnswerRequestInitStage) GetSdp() string
- func (*AnswerRequestInitStage) ProtoMessage()
- func (x *AnswerRequestInitStage) ProtoReflect() protoreflect.Message
- func (x *AnswerRequestInitStage) Reset()
- func (x *AnswerRequestInitStage) String() string
- type AnswerRequestUpdateStage
- func (*AnswerRequestUpdateStage) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerRequestUpdateStage) GetCandidate() *ICECandidate
- func (*AnswerRequestUpdateStage) ProtoMessage()
- func (x *AnswerRequestUpdateStage) ProtoReflect() protoreflect.Message
- func (x *AnswerRequestUpdateStage) Reset()
- func (x *AnswerRequestUpdateStage) String() string
- type AnswerRequest_Done
- type AnswerRequest_Error
- type AnswerRequest_Heartbeat
- type AnswerRequest_Init
- type AnswerRequest_Update
- type AnswerResponse
- func (*AnswerResponse) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerResponse) GetDone() *AnswerResponseDoneStage
- func (x *AnswerResponse) GetError() *AnswerResponseErrorStage
- func (x *AnswerResponse) GetInit() *AnswerResponseInitStage
- func (m *AnswerResponse) GetStage() isAnswerResponse_Stage
- func (x *AnswerResponse) GetUpdate() *AnswerResponseUpdateStage
- func (x *AnswerResponse) GetUuid() string
- func (*AnswerResponse) ProtoMessage()
- func (x *AnswerResponse) ProtoReflect() protoreflect.Message
- func (x *AnswerResponse) Reset()
- func (x *AnswerResponse) String() string
- type AnswerResponseDoneStage
- type AnswerResponseErrorStage
- func (*AnswerResponseErrorStage) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerResponseErrorStage) GetStatus() *status.Status
- func (*AnswerResponseErrorStage) ProtoMessage()
- func (x *AnswerResponseErrorStage) ProtoReflect() protoreflect.Message
- func (x *AnswerResponseErrorStage) Reset()
- func (x *AnswerResponseErrorStage) String() string
- type AnswerResponseInitStage
- func (*AnswerResponseInitStage) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerResponseInitStage) GetSdp() string
- func (*AnswerResponseInitStage) ProtoMessage()
- func (x *AnswerResponseInitStage) ProtoReflect() protoreflect.Message
- func (x *AnswerResponseInitStage) Reset()
- func (x *AnswerResponseInitStage) String() string
- type AnswerResponseUpdateStage
- func (*AnswerResponseUpdateStage) Descriptor() ([]byte, []int)deprecated
- func (x *AnswerResponseUpdateStage) GetCandidate() *ICECandidate
- func (*AnswerResponseUpdateStage) ProtoMessage()
- func (x *AnswerResponseUpdateStage) ProtoReflect() protoreflect.Message
- func (x *AnswerResponseUpdateStage) Reset()
- func (x *AnswerResponseUpdateStage) String() string
- type AnswerResponse_Done
- type AnswerResponse_Error
- type AnswerResponse_Init
- type AnswerResponse_Update
- type CallRequest
- func (*CallRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CallRequest) GetDisableTrickle() bool
- func (x *CallRequest) GetSdp() string
- func (*CallRequest) ProtoMessage()
- func (x *CallRequest) ProtoReflect() protoreflect.Message
- func (x *CallRequest) Reset()
- func (x *CallRequest) String() string
- type CallResponse
- func (*CallResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CallResponse) GetInit() *CallResponseInitStage
- func (m *CallResponse) GetStage() isCallResponse_Stage
- func (x *CallResponse) GetUpdate() *CallResponseUpdateStage
- func (x *CallResponse) GetUuid() string
- func (*CallResponse) ProtoMessage()
- func (x *CallResponse) ProtoReflect() protoreflect.Message
- func (x *CallResponse) Reset()
- func (x *CallResponse) String() string
- type CallResponseInitStage
- func (*CallResponseInitStage) Descriptor() ([]byte, []int)deprecated
- func (x *CallResponseInitStage) GetSdp() string
- func (*CallResponseInitStage) ProtoMessage()
- func (x *CallResponseInitStage) ProtoReflect() protoreflect.Message
- func (x *CallResponseInitStage) Reset()
- func (x *CallResponseInitStage) String() string
- type CallResponseUpdateStage
- func (*CallResponseUpdateStage) Descriptor() ([]byte, []int)deprecated
- func (x *CallResponseUpdateStage) GetCandidate() *ICECandidate
- func (*CallResponseUpdateStage) ProtoMessage()
- func (x *CallResponseUpdateStage) ProtoReflect() protoreflect.Message
- func (x *CallResponseUpdateStage) Reset()
- func (x *CallResponseUpdateStage) String() string
- type CallResponse_Init
- type CallResponse_Update
- type CallUpdateRequest
- func (*CallUpdateRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CallUpdateRequest) GetCandidate() *ICECandidate
- func (x *CallUpdateRequest) GetDone() bool
- func (x *CallUpdateRequest) GetError() *status.Status
- func (m *CallUpdateRequest) GetUpdate() isCallUpdateRequest_Update
- func (x *CallUpdateRequest) GetUuid() string
- func (*CallUpdateRequest) ProtoMessage()
- func (x *CallUpdateRequest) ProtoReflect() protoreflect.Message
- func (x *CallUpdateRequest) Reset()
- func (x *CallUpdateRequest) String() string
- type CallUpdateRequest_Candidate
- type CallUpdateRequest_Done
- type CallUpdateRequest_Error
- type CallUpdateResponse
- type ICECandidate
- func (*ICECandidate) Descriptor() ([]byte, []int)deprecated
- func (x *ICECandidate) GetCandidate() string
- func (x *ICECandidate) GetSdpMid() string
- func (x *ICECandidate) GetSdpmLineIndex() uint32
- func (x *ICECandidate) GetUsernameFragment() string
- func (*ICECandidate) ProtoMessage()
- func (x *ICECandidate) ProtoReflect() protoreflect.Message
- func (x *ICECandidate) Reset()
- func (x *ICECandidate) String() string
- type ICEServer
- func (*ICEServer) Descriptor() ([]byte, []int)deprecated
- func (x *ICEServer) GetCredential() string
- func (x *ICEServer) GetUrls() []string
- func (x *ICEServer) GetUsername() string
- func (*ICEServer) ProtoMessage()
- func (x *ICEServer) ProtoReflect() protoreflect.Message
- func (x *ICEServer) Reset()
- func (x *ICEServer) String() string
- type Metadata
- type OptionalWebRTCConfigRequest
- type OptionalWebRTCConfigResponse
- func (*OptionalWebRTCConfigResponse) Descriptor() ([]byte, []int)deprecated
- func (x *OptionalWebRTCConfigResponse) GetConfig() *WebRTCConfig
- func (*OptionalWebRTCConfigResponse) ProtoMessage()
- func (x *OptionalWebRTCConfigResponse) ProtoReflect() protoreflect.Message
- func (x *OptionalWebRTCConfigResponse) Reset()
- func (x *OptionalWebRTCConfigResponse) String() string
- type PacketMessage
- func (*PacketMessage) Descriptor() ([]byte, []int)deprecated
- func (x *PacketMessage) GetData() []byte
- func (x *PacketMessage) GetEom() bool
- func (*PacketMessage) ProtoMessage()
- func (x *PacketMessage) ProtoReflect() protoreflect.Message
- func (x *PacketMessage) Reset()
- func (x *PacketMessage) String() string
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (x *Request) GetHeaders() *RequestHeaders
- func (x *Request) GetMessage() *RequestMessage
- func (x *Request) GetRstStream() bool
- func (x *Request) GetStream() *Stream
- func (m *Request) GetType() isRequest_Type
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (x *Request) String() string
- type RequestHeaders
- func (*RequestHeaders) Descriptor() ([]byte, []int)deprecated
- func (x *RequestHeaders) GetMetadata() *Metadata
- func (x *RequestHeaders) GetMethod() string
- func (x *RequestHeaders) GetTimeout() *durationpb.Duration
- func (*RequestHeaders) ProtoMessage()
- func (x *RequestHeaders) ProtoReflect() protoreflect.Message
- func (x *RequestHeaders) Reset()
- func (x *RequestHeaders) String() string
- type RequestMessage
- func (*RequestMessage) Descriptor() ([]byte, []int)deprecated
- func (x *RequestMessage) GetEos() bool
- func (x *RequestMessage) GetHasMessage() bool
- func (x *RequestMessage) GetPacketMessage() *PacketMessage
- func (*RequestMessage) ProtoMessage()
- func (x *RequestMessage) ProtoReflect() protoreflect.Message
- func (x *RequestMessage) Reset()
- func (x *RequestMessage) String() string
- type Request_Headers
- type Request_Message
- type Request_RstStream
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetHeaders() *ResponseHeaders
- func (x *Response) GetMessage() *ResponseMessage
- func (x *Response) GetStream() *Stream
- func (x *Response) GetTrailers() *ResponseTrailers
- func (m *Response) GetType() isResponse_Type
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- type ResponseHeaders
- type ResponseMessage
- type ResponseTrailers
- func (*ResponseTrailers) Descriptor() ([]byte, []int)deprecated
- func (x *ResponseTrailers) GetMetadata() *Metadata
- func (x *ResponseTrailers) GetStatus() *status.Status
- func (*ResponseTrailers) ProtoMessage()
- func (x *ResponseTrailers) ProtoReflect() protoreflect.Message
- func (x *ResponseTrailers) Reset()
- func (x *ResponseTrailers) String() string
- type Response_Headers
- type Response_Message
- type Response_Trailers
- type SignalingServiceClient
- type SignalingServiceServer
- type SignalingService_AnswerClient
- type SignalingService_AnswerServer
- type SignalingService_CallClient
- type SignalingService_CallServer
- type Stream
- type Strings
- type UnimplementedSignalingServiceServer
- func (UnimplementedSignalingServiceServer) Answer(SignalingService_AnswerServer) error
- func (UnimplementedSignalingServiceServer) Call(*CallRequest, SignalingService_CallServer) error
- func (UnimplementedSignalingServiceServer) CallUpdate(context.Context, *CallUpdateRequest) (*CallUpdateResponse, error)
- func (UnimplementedSignalingServiceServer) OptionalWebRTCConfig(context.Context, *OptionalWebRTCConfigRequest) (*OptionalWebRTCConfigResponse, error)
- type UnsafeSignalingServiceServer
- type WebRTCConfig
- func (*WebRTCConfig) Descriptor() ([]byte, []int)deprecated
- func (x *WebRTCConfig) GetAdditionalIceServers() []*ICEServer
- func (x *WebRTCConfig) GetDisableTrickle() bool
- func (*WebRTCConfig) ProtoMessage()
- func (x *WebRTCConfig) ProtoReflect() protoreflect.Message
- func (x *WebRTCConfig) Reset()
- func (x *WebRTCConfig) String() string
Constants ¶
This section is empty.
Variables ¶
var File_proto_rpc_webrtc_v1_grpc_proto protoreflect.FileDescriptor
var File_proto_rpc_webrtc_v1_signaling_proto protoreflect.FileDescriptor
var SignalingService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "proto.rpc.webrtc.v1.SignalingService", HandlerType: (*SignalingServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CallUpdate", Handler: _SignalingService_CallUpdate_Handler, }, { MethodName: "OptionalWebRTCConfig", Handler: _SignalingService_OptionalWebRTCConfig_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Call", Handler: _SignalingService_Call_Handler, ServerStreams: true, }, { StreamName: "Answer", Handler: _SignalingService_Answer_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "proto/rpc/webrtc/v1/signaling.proto", }
SignalingService_ServiceDesc is the grpc.ServiceDesc for SignalingService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSignalingServiceHandler ¶
func RegisterSignalingServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterSignalingServiceHandler registers the http handlers for service SignalingService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterSignalingServiceHandlerClient ¶
func RegisterSignalingServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SignalingServiceClient) error
RegisterSignalingServiceHandlerClient registers the http handlers for service SignalingService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SignalingServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SignalingServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SignalingServiceClient" to call the correct interceptors.
func RegisterSignalingServiceHandlerFromEndpoint ¶
func RegisterSignalingServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterSignalingServiceHandlerFromEndpoint is same as RegisterSignalingServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterSignalingServiceHandlerServer ¶
func RegisterSignalingServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SignalingServiceServer) error
RegisterSignalingServiceHandlerServer registers the http handlers for service SignalingService to "mux". UnaryRPC :call SignalingServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterSignalingServiceHandlerFromEndpoint instead.
func RegisterSignalingServiceServer ¶
func RegisterSignalingServiceServer(s grpc.ServiceRegistrar, srv SignalingServiceServer)
Types ¶
type AnswerRequest ¶
type AnswerRequest struct { Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Types that are assignable to Stage: // // *AnswerRequest_Init // *AnswerRequest_Update // *AnswerRequest_Done // *AnswerRequest_Error // *AnswerRequest_Heartbeat Stage isAnswerRequest_Stage `protobuf_oneof:"stage"` // contains filtered or unexported fields }
AnswerRequest is the SDP offer that the controlling side is making via the answering stream.
func (*AnswerRequest) Descriptor
deprecated
func (*AnswerRequest) Descriptor() ([]byte, []int)
Deprecated: Use AnswerRequest.ProtoReflect.Descriptor instead.
func (*AnswerRequest) GetDone ¶ added in v0.0.2
func (x *AnswerRequest) GetDone() *AnswerRequestDoneStage
func (*AnswerRequest) GetError ¶ added in v0.0.2
func (x *AnswerRequest) GetError() *AnswerRequestErrorStage
func (*AnswerRequest) GetHeartbeat ¶ added in v0.1.104
func (x *AnswerRequest) GetHeartbeat() *AnswerRequestHeartbeatStage
func (*AnswerRequest) GetInit ¶ added in v0.0.2
func (x *AnswerRequest) GetInit() *AnswerRequestInitStage
func (*AnswerRequest) GetStage ¶ added in v0.0.2
func (m *AnswerRequest) GetStage() isAnswerRequest_Stage
func (*AnswerRequest) GetUpdate ¶ added in v0.0.2
func (x *AnswerRequest) GetUpdate() *AnswerRequestUpdateStage
func (*AnswerRequest) GetUuid ¶ added in v0.0.2
func (x *AnswerRequest) GetUuid() string
func (*AnswerRequest) ProtoMessage ¶
func (*AnswerRequest) ProtoMessage()
func (*AnswerRequest) ProtoReflect ¶
func (x *AnswerRequest) ProtoReflect() protoreflect.Message
func (*AnswerRequest) Reset ¶
func (x *AnswerRequest) Reset()
func (*AnswerRequest) String ¶
func (x *AnswerRequest) String() string
type AnswerRequestDoneStage ¶ added in v0.0.2
type AnswerRequestDoneStage struct {
// contains filtered or unexported fields
}
AnswerRequestDoneStage indicates the controller is done responding with candidates.
func (*AnswerRequestDoneStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerRequestDoneStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerRequestDoneStage.ProtoReflect.Descriptor instead.
func (*AnswerRequestDoneStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerRequestDoneStage) ProtoMessage()
func (*AnswerRequestDoneStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerRequestDoneStage) ProtoReflect() protoreflect.Message
func (*AnswerRequestDoneStage) Reset ¶ added in v0.0.2
func (x *AnswerRequestDoneStage) Reset()
func (*AnswerRequestDoneStage) String ¶ added in v0.0.2
func (x *AnswerRequestDoneStage) String() string
type AnswerRequestErrorStage ¶ added in v0.0.2
type AnswerRequestErrorStage struct { Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // contains filtered or unexported fields }
AnswerRequestErrorStage indicates the exchange has failed with an error.
func (*AnswerRequestErrorStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerRequestErrorStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerRequestErrorStage.ProtoReflect.Descriptor instead.
func (*AnswerRequestErrorStage) GetStatus ¶ added in v0.0.2
func (x *AnswerRequestErrorStage) GetStatus() *status.Status
func (*AnswerRequestErrorStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerRequestErrorStage) ProtoMessage()
func (*AnswerRequestErrorStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerRequestErrorStage) ProtoReflect() protoreflect.Message
func (*AnswerRequestErrorStage) Reset ¶ added in v0.0.2
func (x *AnswerRequestErrorStage) Reset()
func (*AnswerRequestErrorStage) String ¶ added in v0.0.2
func (x *AnswerRequestErrorStage) String() string
type AnswerRequestHeartbeatStage ¶ added in v0.1.104
type AnswerRequestHeartbeatStage struct {
// contains filtered or unexported fields
}
AnswerRequestHeartbeatStage is sent periodically to verify liveness of answerer.
func (*AnswerRequestHeartbeatStage) Descriptor
deprecated
added in
v0.1.104
func (*AnswerRequestHeartbeatStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerRequestHeartbeatStage.ProtoReflect.Descriptor instead.
func (*AnswerRequestHeartbeatStage) ProtoMessage ¶ added in v0.1.104
func (*AnswerRequestHeartbeatStage) ProtoMessage()
func (*AnswerRequestHeartbeatStage) ProtoReflect ¶ added in v0.1.104
func (x *AnswerRequestHeartbeatStage) ProtoReflect() protoreflect.Message
func (*AnswerRequestHeartbeatStage) Reset ¶ added in v0.1.104
func (x *AnswerRequestHeartbeatStage) Reset()
func (*AnswerRequestHeartbeatStage) String ¶ added in v0.1.104
func (x *AnswerRequestHeartbeatStage) String() string
type AnswerRequestInitStage ¶ added in v0.0.2
type AnswerRequestInitStage struct { Sdp string `protobuf:"bytes,1,opt,name=sdp,proto3" json:"sdp,omitempty"` OptionalConfig *WebRTCConfig `protobuf:"bytes,2,opt,name=optional_config,json=optionalConfig,proto3" json:"optional_config,omitempty"` Deadline *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=deadline,proto3,oneof" json:"deadline,omitempty"` // contains filtered or unexported fields }
AnswerRequestInitStage is the first and a one time stage that represents the callers initial SDP request to the controlled (answerer) side.
func (*AnswerRequestInitStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerRequestInitStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerRequestInitStage.ProtoReflect.Descriptor instead.
func (*AnswerRequestInitStage) GetDeadline ¶ added in v0.1.5
func (x *AnswerRequestInitStage) GetDeadline() *timestamppb.Timestamp
func (*AnswerRequestInitStage) GetOptionalConfig ¶ added in v0.0.2
func (x *AnswerRequestInitStage) GetOptionalConfig() *WebRTCConfig
func (*AnswerRequestInitStage) GetSdp ¶ added in v0.0.2
func (x *AnswerRequestInitStage) GetSdp() string
func (*AnswerRequestInitStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerRequestInitStage) ProtoMessage()
func (*AnswerRequestInitStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerRequestInitStage) ProtoReflect() protoreflect.Message
func (*AnswerRequestInitStage) Reset ¶ added in v0.0.2
func (x *AnswerRequestInitStage) Reset()
func (*AnswerRequestInitStage) String ¶ added in v0.0.2
func (x *AnswerRequestInitStage) String() string
type AnswerRequestUpdateStage ¶ added in v0.0.2
type AnswerRequestUpdateStage struct { Candidate *ICECandidate `protobuf:"bytes,1,opt,name=candidate,proto3" json:"candidate,omitempty"` // contains filtered or unexported fields }
AnswerRequestUpdateStage is multiply used to trickle in ICE candidates to the controlled (answerer) side.
func (*AnswerRequestUpdateStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerRequestUpdateStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerRequestUpdateStage.ProtoReflect.Descriptor instead.
func (*AnswerRequestUpdateStage) GetCandidate ¶ added in v0.0.2
func (x *AnswerRequestUpdateStage) GetCandidate() *ICECandidate
func (*AnswerRequestUpdateStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerRequestUpdateStage) ProtoMessage()
func (*AnswerRequestUpdateStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerRequestUpdateStage) ProtoReflect() protoreflect.Message
func (*AnswerRequestUpdateStage) Reset ¶ added in v0.0.2
func (x *AnswerRequestUpdateStage) Reset()
func (*AnswerRequestUpdateStage) String ¶ added in v0.0.2
func (x *AnswerRequestUpdateStage) String() string
type AnswerRequest_Done ¶ added in v0.0.2
type AnswerRequest_Done struct { // done is sent when the requester is done sending information Done *AnswerRequestDoneStage `protobuf:"bytes,4,opt,name=done,proto3,oneof"` }
type AnswerRequest_Error ¶ added in v0.0.2
type AnswerRequest_Error struct { // error is sent any time before done Error *AnswerRequestErrorStage `protobuf:"bytes,5,opt,name=error,proto3,oneof"` }
type AnswerRequest_Heartbeat ¶ added in v0.1.104
type AnswerRequest_Heartbeat struct { // heartbeat is sent periodically to verify liveness of answerer Heartbeat *AnswerRequestHeartbeatStage `protobuf:"bytes,6,opt,name=heartbeat,proto3,oneof"` }
type AnswerRequest_Init ¶ added in v0.0.2
type AnswerRequest_Init struct {
Init *AnswerRequestInitStage `protobuf:"bytes,2,opt,name=init,proto3,oneof"`
}
type AnswerRequest_Update ¶ added in v0.0.2
type AnswerRequest_Update struct {
Update *AnswerRequestUpdateStage `protobuf:"bytes,3,opt,name=update,proto3,oneof"`
}
type AnswerResponse ¶
type AnswerResponse struct { Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Types that are assignable to Stage: // // *AnswerResponse_Init // *AnswerResponse_Update // *AnswerResponse_Done // *AnswerResponse_Error Stage isAnswerResponse_Stage `protobuf_oneof:"stage"` // contains filtered or unexported fields }
AnswerResponse is the SDP answer that an answerer responds with.
func (*AnswerResponse) Descriptor
deprecated
func (*AnswerResponse) Descriptor() ([]byte, []int)
Deprecated: Use AnswerResponse.ProtoReflect.Descriptor instead.
func (*AnswerResponse) GetDone ¶ added in v0.0.2
func (x *AnswerResponse) GetDone() *AnswerResponseDoneStage
func (*AnswerResponse) GetError ¶ added in v0.0.2
func (x *AnswerResponse) GetError() *AnswerResponseErrorStage
func (*AnswerResponse) GetInit ¶ added in v0.0.2
func (x *AnswerResponse) GetInit() *AnswerResponseInitStage
func (*AnswerResponse) GetStage ¶ added in v0.0.2
func (m *AnswerResponse) GetStage() isAnswerResponse_Stage
func (*AnswerResponse) GetUpdate ¶ added in v0.0.2
func (x *AnswerResponse) GetUpdate() *AnswerResponseUpdateStage
func (*AnswerResponse) GetUuid ¶ added in v0.0.2
func (x *AnswerResponse) GetUuid() string
func (*AnswerResponse) ProtoMessage ¶
func (*AnswerResponse) ProtoMessage()
func (*AnswerResponse) ProtoReflect ¶
func (x *AnswerResponse) ProtoReflect() protoreflect.Message
func (*AnswerResponse) Reset ¶
func (x *AnswerResponse) Reset()
func (*AnswerResponse) String ¶
func (x *AnswerResponse) String() string
type AnswerResponseDoneStage ¶ added in v0.0.2
type AnswerResponseDoneStage struct {
// contains filtered or unexported fields
}
AnswerResponseDoneStage indicates the answerer is done responding with candidates.
func (*AnswerResponseDoneStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerResponseDoneStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerResponseDoneStage.ProtoReflect.Descriptor instead.
func (*AnswerResponseDoneStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerResponseDoneStage) ProtoMessage()
func (*AnswerResponseDoneStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerResponseDoneStage) ProtoReflect() protoreflect.Message
func (*AnswerResponseDoneStage) Reset ¶ added in v0.0.2
func (x *AnswerResponseDoneStage) Reset()
func (*AnswerResponseDoneStage) String ¶ added in v0.0.2
func (x *AnswerResponseDoneStage) String() string
type AnswerResponseErrorStage ¶ added in v0.0.2
type AnswerResponseErrorStage struct { Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // contains filtered or unexported fields }
AnswerResponseErrorStage indicates the exchange has failed with an error.
func (*AnswerResponseErrorStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerResponseErrorStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerResponseErrorStage.ProtoReflect.Descriptor instead.
func (*AnswerResponseErrorStage) GetStatus ¶ added in v0.0.2
func (x *AnswerResponseErrorStage) GetStatus() *status.Status
func (*AnswerResponseErrorStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerResponseErrorStage) ProtoMessage()
func (*AnswerResponseErrorStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerResponseErrorStage) ProtoReflect() protoreflect.Message
func (*AnswerResponseErrorStage) Reset ¶ added in v0.0.2
func (x *AnswerResponseErrorStage) Reset()
func (*AnswerResponseErrorStage) String ¶ added in v0.0.2
func (x *AnswerResponseErrorStage) String() string
type AnswerResponseInitStage ¶ added in v0.0.2
type AnswerResponseInitStage struct { Sdp string `protobuf:"bytes,1,opt,name=sdp,proto3" json:"sdp,omitempty"` // contains filtered or unexported fields }
AnswerResponseInitStage is the first and a one time stage that represents the answerers initial SDP response to the controlling side.
func (*AnswerResponseInitStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerResponseInitStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerResponseInitStage.ProtoReflect.Descriptor instead.
func (*AnswerResponseInitStage) GetSdp ¶ added in v0.0.2
func (x *AnswerResponseInitStage) GetSdp() string
func (*AnswerResponseInitStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerResponseInitStage) ProtoMessage()
func (*AnswerResponseInitStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerResponseInitStage) ProtoReflect() protoreflect.Message
func (*AnswerResponseInitStage) Reset ¶ added in v0.0.2
func (x *AnswerResponseInitStage) Reset()
func (*AnswerResponseInitStage) String ¶ added in v0.0.2
func (x *AnswerResponseInitStage) String() string
type AnswerResponseUpdateStage ¶ added in v0.0.2
type AnswerResponseUpdateStage struct { Candidate *ICECandidate `protobuf:"bytes,1,opt,name=candidate,proto3" json:"candidate,omitempty"` // contains filtered or unexported fields }
AnswerResponseUpdateStage is multiply used to trickle in ICE candidates to the controlling side.
func (*AnswerResponseUpdateStage) Descriptor
deprecated
added in
v0.0.2
func (*AnswerResponseUpdateStage) Descriptor() ([]byte, []int)
Deprecated: Use AnswerResponseUpdateStage.ProtoReflect.Descriptor instead.
func (*AnswerResponseUpdateStage) GetCandidate ¶ added in v0.0.2
func (x *AnswerResponseUpdateStage) GetCandidate() *ICECandidate
func (*AnswerResponseUpdateStage) ProtoMessage ¶ added in v0.0.2
func (*AnswerResponseUpdateStage) ProtoMessage()
func (*AnswerResponseUpdateStage) ProtoReflect ¶ added in v0.0.2
func (x *AnswerResponseUpdateStage) ProtoReflect() protoreflect.Message
func (*AnswerResponseUpdateStage) Reset ¶ added in v0.0.2
func (x *AnswerResponseUpdateStage) Reset()
func (*AnswerResponseUpdateStage) String ¶ added in v0.0.2
func (x *AnswerResponseUpdateStage) String() string
type AnswerResponse_Done ¶ added in v0.0.2
type AnswerResponse_Done struct { // done is sent when the answerer is done sending information Done *AnswerResponseDoneStage `protobuf:"bytes,4,opt,name=done,proto3,oneof"` }
type AnswerResponse_Error ¶ added in v0.0.2
type AnswerResponse_Error struct { // error is sent any time before done Error *AnswerResponseErrorStage `protobuf:"bytes,5,opt,name=error,proto3,oneof"` }
type AnswerResponse_Init ¶ added in v0.0.2
type AnswerResponse_Init struct {
Init *AnswerResponseInitStage `protobuf:"bytes,2,opt,name=init,proto3,oneof"`
}
type AnswerResponse_Update ¶ added in v0.0.2
type AnswerResponse_Update struct {
Update *AnswerResponseUpdateStage `protobuf:"bytes,3,opt,name=update,proto3,oneof"`
}
type CallRequest ¶
type CallRequest struct { Sdp string `protobuf:"bytes,1,opt,name=sdp,proto3" json:"sdp,omitempty"` // when disable_trickle is true, the init stage will be the only stage // to be received in the response and the caller can expect the SDP // to contain all ICE candidates. DisableTrickle bool `protobuf:"varint,2,opt,name=disable_trickle,json=disableTrickle,proto3" json:"disable_trickle,omitempty"` // contains filtered or unexported fields }
CallRequest is the SDP offer that the controlling side is making.
func (*CallRequest) Descriptor
deprecated
func (*CallRequest) Descriptor() ([]byte, []int)
Deprecated: Use CallRequest.ProtoReflect.Descriptor instead.
func (*CallRequest) GetDisableTrickle ¶ added in v0.0.2
func (x *CallRequest) GetDisableTrickle() bool
func (*CallRequest) GetSdp ¶
func (x *CallRequest) GetSdp() string
func (*CallRequest) ProtoMessage ¶
func (*CallRequest) ProtoMessage()
func (*CallRequest) ProtoReflect ¶
func (x *CallRequest) ProtoReflect() protoreflect.Message
func (*CallRequest) Reset ¶
func (x *CallRequest) Reset()
func (*CallRequest) String ¶
func (x *CallRequest) String() string
type CallResponse ¶
type CallResponse struct { Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Types that are assignable to Stage: // // *CallResponse_Init // *CallResponse_Update Stage isCallResponse_Stage `protobuf_oneof:"stage"` // contains filtered or unexported fields }
CallResponse is the SDP answer that the controlled side responds with.
func (*CallResponse) Descriptor
deprecated
func (*CallResponse) Descriptor() ([]byte, []int)
Deprecated: Use CallResponse.ProtoReflect.Descriptor instead.
func (*CallResponse) GetInit ¶ added in v0.0.2
func (x *CallResponse) GetInit() *CallResponseInitStage
func (*CallResponse) GetStage ¶ added in v0.0.2
func (m *CallResponse) GetStage() isCallResponse_Stage
func (*CallResponse) GetUpdate ¶ added in v0.0.2
func (x *CallResponse) GetUpdate() *CallResponseUpdateStage
func (*CallResponse) GetUuid ¶ added in v0.0.2
func (x *CallResponse) GetUuid() string
func (*CallResponse) ProtoMessage ¶
func (*CallResponse) ProtoMessage()
func (*CallResponse) ProtoReflect ¶
func (x *CallResponse) ProtoReflect() protoreflect.Message
func (*CallResponse) Reset ¶
func (x *CallResponse) Reset()
func (*CallResponse) String ¶
func (x *CallResponse) String() string
type CallResponseInitStage ¶ added in v0.0.2
type CallResponseInitStage struct { Sdp string `protobuf:"bytes,1,opt,name=sdp,proto3" json:"sdp,omitempty"` // contains filtered or unexported fields }
CallResponseInitStage is the first and a one time stage that represents the initial response to starting a call.
func (*CallResponseInitStage) Descriptor
deprecated
added in
v0.0.2
func (*CallResponseInitStage) Descriptor() ([]byte, []int)
Deprecated: Use CallResponseInitStage.ProtoReflect.Descriptor instead.
func (*CallResponseInitStage) GetSdp ¶ added in v0.0.2
func (x *CallResponseInitStage) GetSdp() string
func (*CallResponseInitStage) ProtoMessage ¶ added in v0.0.2
func (*CallResponseInitStage) ProtoMessage()
func (*CallResponseInitStage) ProtoReflect ¶ added in v0.0.2
func (x *CallResponseInitStage) ProtoReflect() protoreflect.Message
func (*CallResponseInitStage) Reset ¶ added in v0.0.2
func (x *CallResponseInitStage) Reset()
func (*CallResponseInitStage) String ¶ added in v0.0.2
func (x *CallResponseInitStage) String() string
type CallResponseUpdateStage ¶ added in v0.0.2
type CallResponseUpdateStage struct { Candidate *ICECandidate `protobuf:"bytes,1,opt,name=candidate,proto3" json:"candidate,omitempty"` // contains filtered or unexported fields }
CallResponseUpdateStage is multiply used to trickle in ICE candidates from the controlled (answering) side.
func (*CallResponseUpdateStage) Descriptor
deprecated
added in
v0.0.2
func (*CallResponseUpdateStage) Descriptor() ([]byte, []int)
Deprecated: Use CallResponseUpdateStage.ProtoReflect.Descriptor instead.
func (*CallResponseUpdateStage) GetCandidate ¶ added in v0.0.2
func (x *CallResponseUpdateStage) GetCandidate() *ICECandidate
func (*CallResponseUpdateStage) ProtoMessage ¶ added in v0.0.2
func (*CallResponseUpdateStage) ProtoMessage()
func (*CallResponseUpdateStage) ProtoReflect ¶ added in v0.0.2
func (x *CallResponseUpdateStage) ProtoReflect() protoreflect.Message
func (*CallResponseUpdateStage) Reset ¶ added in v0.0.2
func (x *CallResponseUpdateStage) Reset()
func (*CallResponseUpdateStage) String ¶ added in v0.0.2
func (x *CallResponseUpdateStage) String() string
type CallResponse_Init ¶ added in v0.0.2
type CallResponse_Init struct {
Init *CallResponseInitStage `protobuf:"bytes,2,opt,name=init,proto3,oneof"`
}
type CallResponse_Update ¶ added in v0.0.2
type CallResponse_Update struct {
Update *CallResponseUpdateStage `protobuf:"bytes,3,opt,name=update,proto3,oneof"`
}
type CallUpdateRequest ¶ added in v0.0.2
type CallUpdateRequest struct { Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Types that are assignable to Update: // // *CallUpdateRequest_Candidate // *CallUpdateRequest_Done // *CallUpdateRequest_Error Update isCallUpdateRequest_Update `protobuf_oneof:"update"` // contains filtered or unexported fields }
CallUpdateRequest updates the call with additional info to the controlled side.
func (*CallUpdateRequest) Descriptor
deprecated
added in
v0.0.2
func (*CallUpdateRequest) Descriptor() ([]byte, []int)
Deprecated: Use CallUpdateRequest.ProtoReflect.Descriptor instead.
func (*CallUpdateRequest) GetCandidate ¶ added in v0.0.2
func (x *CallUpdateRequest) GetCandidate() *ICECandidate
func (*CallUpdateRequest) GetDone ¶ added in v0.0.2
func (x *CallUpdateRequest) GetDone() bool
func (*CallUpdateRequest) GetError ¶ added in v0.0.2
func (x *CallUpdateRequest) GetError() *status.Status
func (*CallUpdateRequest) GetUpdate ¶ added in v0.0.2
func (m *CallUpdateRequest) GetUpdate() isCallUpdateRequest_Update
func (*CallUpdateRequest) GetUuid ¶ added in v0.0.2
func (x *CallUpdateRequest) GetUuid() string
func (*CallUpdateRequest) ProtoMessage ¶ added in v0.0.2
func (*CallUpdateRequest) ProtoMessage()
func (*CallUpdateRequest) ProtoReflect ¶ added in v0.0.2
func (x *CallUpdateRequest) ProtoReflect() protoreflect.Message
func (*CallUpdateRequest) Reset ¶ added in v0.0.2
func (x *CallUpdateRequest) Reset()
func (*CallUpdateRequest) String ¶ added in v0.0.2
func (x *CallUpdateRequest) String() string
type CallUpdateRequest_Candidate ¶ added in v0.0.2
type CallUpdateRequest_Candidate struct {
Candidate *ICECandidate `protobuf:"bytes,2,opt,name=candidate,proto3,oneof"`
}
type CallUpdateRequest_Done ¶ added in v0.0.2
type CallUpdateRequest_Done struct {
Done bool `protobuf:"varint,3,opt,name=done,proto3,oneof"`
}
type CallUpdateRequest_Error ¶ added in v0.0.2
type CallUpdateResponse ¶ added in v0.0.2
type CallUpdateResponse struct {
// contains filtered or unexported fields
}
CallUpdateResponse contains nothing in response to a call update.
func (*CallUpdateResponse) Descriptor
deprecated
added in
v0.0.2
func (*CallUpdateResponse) Descriptor() ([]byte, []int)
Deprecated: Use CallUpdateResponse.ProtoReflect.Descriptor instead.
func (*CallUpdateResponse) ProtoMessage ¶ added in v0.0.2
func (*CallUpdateResponse) ProtoMessage()
func (*CallUpdateResponse) ProtoReflect ¶ added in v0.0.2
func (x *CallUpdateResponse) ProtoReflect() protoreflect.Message
func (*CallUpdateResponse) Reset ¶ added in v0.0.2
func (x *CallUpdateResponse) Reset()
func (*CallUpdateResponse) String ¶ added in v0.0.2
func (x *CallUpdateResponse) String() string
type ICECandidate ¶ added in v0.0.2
type ICECandidate struct { Candidate string `protobuf:"bytes,1,opt,name=candidate,proto3" json:"candidate,omitempty"` SdpMid *string `protobuf:"bytes,2,opt,name=sdp_mid,json=sdpMid,proto3,oneof" json:"sdp_mid,omitempty"` SdpmLineIndex *uint32 `protobuf:"varint,3,opt,name=sdpm_line_index,json=sdpmLineIndex,proto3,oneof" json:"sdpm_line_index,omitempty"` UsernameFragment *string `protobuf:"bytes,4,opt,name=username_fragment,json=usernameFragment,proto3,oneof" json:"username_fragment,omitempty"` // contains filtered or unexported fields }
ICECandidate represents an ICE candidate. From https://github.com/pion/webrtc/blob/5f6baf73255598a7b4a7c9400bb0381acc9aa3dc/icecandidateinit.go
func (*ICECandidate) Descriptor
deprecated
added in
v0.0.2
func (*ICECandidate) Descriptor() ([]byte, []int)
Deprecated: Use ICECandidate.ProtoReflect.Descriptor instead.
func (*ICECandidate) GetCandidate ¶ added in v0.0.2
func (x *ICECandidate) GetCandidate() string
func (*ICECandidate) GetSdpMid ¶ added in v0.0.2
func (x *ICECandidate) GetSdpMid() string
func (*ICECandidate) GetSdpmLineIndex ¶ added in v0.0.2
func (x *ICECandidate) GetSdpmLineIndex() uint32
func (*ICECandidate) GetUsernameFragment ¶ added in v0.0.2
func (x *ICECandidate) GetUsernameFragment() string
func (*ICECandidate) ProtoMessage ¶ added in v0.0.2
func (*ICECandidate) ProtoMessage()
func (*ICECandidate) ProtoReflect ¶ added in v0.0.2
func (x *ICECandidate) ProtoReflect() protoreflect.Message
func (*ICECandidate) Reset ¶ added in v0.0.2
func (x *ICECandidate) Reset()
func (*ICECandidate) String ¶ added in v0.0.2
func (x *ICECandidate) String() string
type ICEServer ¶ added in v0.0.2
type ICEServer struct { Urls []string `protobuf:"bytes,1,rep,name=urls,proto3" json:"urls,omitempty"` Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"` Credential string `protobuf:"bytes,3,opt,name=credential,proto3" json:"credential,omitempty"` // contains filtered or unexported fields }
ICEServer describes an ICE server.
func (*ICEServer) Descriptor
deprecated
added in
v0.0.2
func (*ICEServer) GetCredential ¶ added in v0.0.2
func (*ICEServer) GetUsername ¶ added in v0.0.2
func (*ICEServer) ProtoMessage ¶ added in v0.0.2
func (*ICEServer) ProtoMessage()
func (*ICEServer) ProtoReflect ¶ added in v0.0.2
func (x *ICEServer) ProtoReflect() protoreflect.Message
type Metadata ¶
type Metadata struct { Md map[string]*Strings `` /* 145-byte string literal not displayed */ // contains filtered or unexported fields }
Metadata is for custom key values provided by a client or server during a stream.
func (*Metadata) Descriptor
deprecated
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()
func (*Metadata) ProtoReflect ¶
func (x *Metadata) ProtoReflect() protoreflect.Message
type OptionalWebRTCConfigRequest ¶ added in v0.0.2
type OptionalWebRTCConfigRequest struct {
// contains filtered or unexported fields
}
OptionalWebRTCConfigRequest is the request for getting an optional WebRTC config to use for the peer connection.
func (*OptionalWebRTCConfigRequest) Descriptor
deprecated
added in
v0.0.2
func (*OptionalWebRTCConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use OptionalWebRTCConfigRequest.ProtoReflect.Descriptor instead.
func (*OptionalWebRTCConfigRequest) ProtoMessage ¶ added in v0.0.2
func (*OptionalWebRTCConfigRequest) ProtoMessage()
func (*OptionalWebRTCConfigRequest) ProtoReflect ¶ added in v0.0.2
func (x *OptionalWebRTCConfigRequest) ProtoReflect() protoreflect.Message
func (*OptionalWebRTCConfigRequest) Reset ¶ added in v0.0.2
func (x *OptionalWebRTCConfigRequest) Reset()
func (*OptionalWebRTCConfigRequest) String ¶ added in v0.0.2
func (x *OptionalWebRTCConfigRequest) String() string
type OptionalWebRTCConfigResponse ¶ added in v0.0.2
type OptionalWebRTCConfigResponse struct { Config *WebRTCConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"` // contains filtered or unexported fields }
OptionalWebRTCConfigResponse contains the optional WebRTC config to use for the peer connection.
func (*OptionalWebRTCConfigResponse) Descriptor
deprecated
added in
v0.0.2
func (*OptionalWebRTCConfigResponse) Descriptor() ([]byte, []int)
Deprecated: Use OptionalWebRTCConfigResponse.ProtoReflect.Descriptor instead.
func (*OptionalWebRTCConfigResponse) GetConfig ¶ added in v0.0.2
func (x *OptionalWebRTCConfigResponse) GetConfig() *WebRTCConfig
func (*OptionalWebRTCConfigResponse) ProtoMessage ¶ added in v0.0.2
func (*OptionalWebRTCConfigResponse) ProtoMessage()
func (*OptionalWebRTCConfigResponse) ProtoReflect ¶ added in v0.0.2
func (x *OptionalWebRTCConfigResponse) ProtoReflect() protoreflect.Message
func (*OptionalWebRTCConfigResponse) Reset ¶ added in v0.0.2
func (x *OptionalWebRTCConfigResponse) Reset()
func (*OptionalWebRTCConfigResponse) String ¶ added in v0.0.2
func (x *OptionalWebRTCConfigResponse) String() string
type PacketMessage ¶
type PacketMessage struct { Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` Eom bool `protobuf:"varint,2,opt,name=eom,proto3" json:"eom,omitempty"` // contains filtered or unexported fields }
A PacketMessage is used to packetize large messages (> 64KiB) to be able to safely transmit over WebRTC data channels.
func (*PacketMessage) Descriptor
deprecated
func (*PacketMessage) Descriptor() ([]byte, []int)
Deprecated: Use PacketMessage.ProtoReflect.Descriptor instead.
func (*PacketMessage) GetData ¶
func (x *PacketMessage) GetData() []byte
func (*PacketMessage) GetEom ¶
func (x *PacketMessage) GetEom() bool
func (*PacketMessage) ProtoMessage ¶
func (*PacketMessage) ProtoMessage()
func (*PacketMessage) ProtoReflect ¶
func (x *PacketMessage) ProtoReflect() protoreflect.Message
func (*PacketMessage) Reset ¶
func (x *PacketMessage) Reset()
func (*PacketMessage) String ¶
func (x *PacketMessage) String() string
type Request ¶
type Request struct { Stream *Stream `protobuf:"bytes,1,opt,name=stream,proto3" json:"stream,omitempty"` // Types that are assignable to Type: // // *Request_Headers // *Request_Message // *Request_RstStream Type isRequest_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
A Request is a frame coming from a client. It is always associated with a stream where the client assigns the stream identifier. Servers will drop frames where the stream identifier has no association (if a non-header frames are sent).
func (*Request) Descriptor
deprecated
func (*Request) GetHeaders ¶
func (x *Request) GetHeaders() *RequestHeaders
func (*Request) GetMessage ¶
func (x *Request) GetMessage() *RequestMessage
func (*Request) GetRstStream ¶ added in v0.0.6
func (*Request) ProtoMessage ¶
func (*Request) ProtoMessage()
func (*Request) ProtoReflect ¶
func (x *Request) ProtoReflect() protoreflect.Message
type RequestHeaders ¶
type RequestHeaders struct { Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"` Metadata *Metadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"` Timeout *durationpb.Duration `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty"` // contains filtered or unexported fields }
RequestHeaders describe the unary or streaming call to make.
func (*RequestHeaders) Descriptor
deprecated
func (*RequestHeaders) Descriptor() ([]byte, []int)
Deprecated: Use RequestHeaders.ProtoReflect.Descriptor instead.
func (*RequestHeaders) GetMetadata ¶
func (x *RequestHeaders) GetMetadata() *Metadata
func (*RequestHeaders) GetMethod ¶
func (x *RequestHeaders) GetMethod() string
func (*RequestHeaders) GetTimeout ¶
func (x *RequestHeaders) GetTimeout() *durationpb.Duration
func (*RequestHeaders) ProtoMessage ¶
func (*RequestHeaders) ProtoMessage()
func (*RequestHeaders) ProtoReflect ¶
func (x *RequestHeaders) ProtoReflect() protoreflect.Message
func (*RequestHeaders) Reset ¶
func (x *RequestHeaders) Reset()
func (*RequestHeaders) String ¶
func (x *RequestHeaders) String() string
type RequestMessage ¶
type RequestMessage struct { HasMessage bool `protobuf:"varint,1,opt,name=has_message,json=hasMessage,proto3" json:"has_message,omitempty"` PacketMessage *PacketMessage `protobuf:"bytes,2,opt,name=packet_message,json=packetMessage,proto3" json:"packet_message,omitempty"` Eos bool `protobuf:"varint,3,opt,name=eos,proto3" json:"eos,omitempty"` // contains filtered or unexported fields }
A RequestMessage contains individual gRPC messages and a potential end-of-stream (EOS) marker.
func (*RequestMessage) Descriptor
deprecated
func (*RequestMessage) Descriptor() ([]byte, []int)
Deprecated: Use RequestMessage.ProtoReflect.Descriptor instead.
func (*RequestMessage) GetEos ¶
func (x *RequestMessage) GetEos() bool
func (*RequestMessage) GetHasMessage ¶
func (x *RequestMessage) GetHasMessage() bool
func (*RequestMessage) GetPacketMessage ¶
func (x *RequestMessage) GetPacketMessage() *PacketMessage
func (*RequestMessage) ProtoMessage ¶
func (*RequestMessage) ProtoMessage()
func (*RequestMessage) ProtoReflect ¶
func (x *RequestMessage) ProtoReflect() protoreflect.Message
func (*RequestMessage) Reset ¶
func (x *RequestMessage) Reset()
func (*RequestMessage) String ¶
func (x *RequestMessage) String() string
type Request_Headers ¶
type Request_Headers struct {
Headers *RequestHeaders `protobuf:"bytes,2,opt,name=headers,proto3,oneof"`
}
type Request_Message ¶
type Request_Message struct {
Message *RequestMessage `protobuf:"bytes,3,opt,name=message,proto3,oneof"`
}
type Request_RstStream ¶ added in v0.0.6
type Request_RstStream struct {
RstStream bool `protobuf:"varint,4,opt,name=rst_stream,json=rstStream,proto3,oneof"`
}
type Response ¶
type Response struct { Stream *Stream `protobuf:"bytes,1,opt,name=stream,proto3" json:"stream,omitempty"` // Types that are assignable to Type: // // *Response_Headers // *Response_Message // *Response_Trailers Type isResponse_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
A Response is a frame coming from a server. It is always associated with a stream where the client assigns the stream identifier. Clients will drop frames where the stream identifier has no association.
func (*Response) Descriptor
deprecated
func (*Response) GetHeaders ¶
func (x *Response) GetHeaders() *ResponseHeaders
func (*Response) GetMessage ¶
func (x *Response) GetMessage() *ResponseMessage
func (*Response) GetTrailers ¶
func (x *Response) GetTrailers() *ResponseTrailers
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
type ResponseHeaders ¶
type ResponseHeaders struct { Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"` // contains filtered or unexported fields }
ResponseHeaders contain custom metadata that are sent to the client before any message or trailers (unless only trailers are sent).
func (*ResponseHeaders) Descriptor
deprecated
func (*ResponseHeaders) Descriptor() ([]byte, []int)
Deprecated: Use ResponseHeaders.ProtoReflect.Descriptor instead.
func (*ResponseHeaders) GetMetadata ¶
func (x *ResponseHeaders) GetMetadata() *Metadata
func (*ResponseHeaders) ProtoMessage ¶
func (*ResponseHeaders) ProtoMessage()
func (*ResponseHeaders) ProtoReflect ¶
func (x *ResponseHeaders) ProtoReflect() protoreflect.Message
func (*ResponseHeaders) Reset ¶
func (x *ResponseHeaders) Reset()
func (*ResponseHeaders) String ¶
func (x *ResponseHeaders) String() string
type ResponseMessage ¶
type ResponseMessage struct { PacketMessage *PacketMessage `protobuf:"bytes,1,opt,name=packet_message,json=packetMessage,proto3" json:"packet_message,omitempty"` // contains filtered or unexported fields }
ResponseMessage contains the data of a response to a call.
func (*ResponseMessage) Descriptor
deprecated
func (*ResponseMessage) Descriptor() ([]byte, []int)
Deprecated: Use ResponseMessage.ProtoReflect.Descriptor instead.
func (*ResponseMessage) GetPacketMessage ¶
func (x *ResponseMessage) GetPacketMessage() *PacketMessage
func (*ResponseMessage) ProtoMessage ¶
func (*ResponseMessage) ProtoMessage()
func (*ResponseMessage) ProtoReflect ¶
func (x *ResponseMessage) ProtoReflect() protoreflect.Message
func (*ResponseMessage) Reset ¶
func (x *ResponseMessage) Reset()
func (*ResponseMessage) String ¶
func (x *ResponseMessage) String() string
type ResponseTrailers ¶
type ResponseTrailers struct { Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` Metadata *Metadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"` // contains filtered or unexported fields }
ResponseTrailers contain the status of a response and any custom metadata.
func (*ResponseTrailers) Descriptor
deprecated
func (*ResponseTrailers) Descriptor() ([]byte, []int)
Deprecated: Use ResponseTrailers.ProtoReflect.Descriptor instead.
func (*ResponseTrailers) GetMetadata ¶
func (x *ResponseTrailers) GetMetadata() *Metadata
func (*ResponseTrailers) GetStatus ¶
func (x *ResponseTrailers) GetStatus() *status.Status
func (*ResponseTrailers) ProtoMessage ¶
func (*ResponseTrailers) ProtoMessage()
func (*ResponseTrailers) ProtoReflect ¶
func (x *ResponseTrailers) ProtoReflect() protoreflect.Message
func (*ResponseTrailers) Reset ¶
func (x *ResponseTrailers) Reset()
func (*ResponseTrailers) String ¶
func (x *ResponseTrailers) String() string
type Response_Headers ¶
type Response_Headers struct {
Headers *ResponseHeaders `protobuf:"bytes,2,opt,name=headers,proto3,oneof"`
}
type Response_Message ¶
type Response_Message struct {
Message *ResponseMessage `protobuf:"bytes,3,opt,name=message,proto3,oneof"`
}
type Response_Trailers ¶
type Response_Trailers struct {
Trailers *ResponseTrailers `protobuf:"bytes,4,opt,name=trailers,proto3,oneof"`
}
type SignalingServiceClient ¶
type SignalingServiceClient interface { // Call makes an offer to a client that it expects an answer to. The host // of the client in question should be identified in the rpc-host metadata // field. // Note: Based on how this is a server streaming responnse to the caller, // we do not have a good way of knowing if the caller has disappeared. // Depending on answerer timeouts and concurrency limits, this can result in // hangs on the answerer waiting for a connection to establish, which in turn // can result in the caller waiting for an answerer to be listening. Call(ctx context.Context, in *CallRequest, opts ...grpc.CallOption) (SignalingService_CallClient, error) // CallUpdate is used to send additional info in relation to a Call. // The host of the client for the call in question should be identified // in the rpc-host metadata field. // In a world where https://github.com/grpc/grpc-web/issues/24 is fixed, // this should be removed in favor of a bidirectional stream on Call. CallUpdate(ctx context.Context, in *CallUpdateRequest, opts ...grpc.CallOption) (*CallUpdateResponse, error) // Answer sets up an answering service where the caller answers call offers // and responds with answers. // The host(s) to answer for should be in the rpc-host metadata field. Answer(ctx context.Context, opts ...grpc.CallOption) (SignalingService_AnswerClient, error) // OptionalWebRTCConfig returns any WebRTC configuration the caller may want to use. // The host to get a config for must be in the rpc-host metadata field. OptionalWebRTCConfig(ctx context.Context, in *OptionalWebRTCConfigRequest, opts ...grpc.CallOption) (*OptionalWebRTCConfigResponse, error) }
SignalingServiceClient is the client API for SignalingService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSignalingServiceClient ¶
func NewSignalingServiceClient(cc grpc.ClientConnInterface) SignalingServiceClient
type SignalingServiceServer ¶
type SignalingServiceServer interface { // Call makes an offer to a client that it expects an answer to. The host // of the client in question should be identified in the rpc-host metadata // field. // Note: Based on how this is a server streaming responnse to the caller, // we do not have a good way of knowing if the caller has disappeared. // Depending on answerer timeouts and concurrency limits, this can result in // hangs on the answerer waiting for a connection to establish, which in turn // can result in the caller waiting for an answerer to be listening. Call(*CallRequest, SignalingService_CallServer) error // CallUpdate is used to send additional info in relation to a Call. // The host of the client for the call in question should be identified // in the rpc-host metadata field. // In a world where https://github.com/grpc/grpc-web/issues/24 is fixed, // this should be removed in favor of a bidirectional stream on Call. CallUpdate(context.Context, *CallUpdateRequest) (*CallUpdateResponse, error) // Answer sets up an answering service where the caller answers call offers // and responds with answers. // The host(s) to answer for should be in the rpc-host metadata field. Answer(SignalingService_AnswerServer) error // OptionalWebRTCConfig returns any WebRTC configuration the caller may want to use. // The host to get a config for must be in the rpc-host metadata field. OptionalWebRTCConfig(context.Context, *OptionalWebRTCConfigRequest) (*OptionalWebRTCConfigResponse, error) // contains filtered or unexported methods }
SignalingServiceServer is the server API for SignalingService service. All implementations must embed UnimplementedSignalingServiceServer for forward compatibility
type SignalingService_AnswerClient ¶
type SignalingService_AnswerClient interface { Send(*AnswerResponse) error Recv() (*AnswerRequest, error) grpc.ClientStream }
type SignalingService_AnswerServer ¶
type SignalingService_AnswerServer interface { Send(*AnswerRequest) error Recv() (*AnswerResponse, error) grpc.ServerStream }
type SignalingService_CallClient ¶ added in v0.0.2
type SignalingService_CallClient interface { Recv() (*CallResponse, error) grpc.ClientStream }
type SignalingService_CallServer ¶ added in v0.0.2
type SignalingService_CallServer interface { Send(*CallResponse) error grpc.ServerStream }
type Stream ¶
type Stream struct { Id uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
A Stream represents an instance of a gRPC stream between a client and a server.
func (*Stream) Descriptor
deprecated
func (*Stream) ProtoMessage ¶
func (*Stream) ProtoMessage()
func (*Stream) ProtoReflect ¶
func (x *Stream) ProtoReflect() protoreflect.Message
type Strings ¶
type Strings struct { Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"` // contains filtered or unexported fields }
Strings are a series of values.
func (*Strings) Descriptor
deprecated
func (*Strings) ProtoMessage ¶
func (*Strings) ProtoMessage()
func (*Strings) ProtoReflect ¶
func (x *Strings) ProtoReflect() protoreflect.Message
type UnimplementedSignalingServiceServer ¶
type UnimplementedSignalingServiceServer struct { }
UnimplementedSignalingServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedSignalingServiceServer) CallUpdate ¶ added in v0.0.2
func (UnimplementedSignalingServiceServer) CallUpdate(context.Context, *CallUpdateRequest) (*CallUpdateResponse, error)
func (UnimplementedSignalingServiceServer) OptionalWebRTCConfig ¶ added in v0.0.2
func (UnimplementedSignalingServiceServer) OptionalWebRTCConfig(context.Context, *OptionalWebRTCConfigRequest) (*OptionalWebRTCConfigResponse, error)
type UnsafeSignalingServiceServer ¶
type UnsafeSignalingServiceServer interface {
// contains filtered or unexported methods
}
UnsafeSignalingServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SignalingServiceServer will result in compilation errors.
type WebRTCConfig ¶ added in v0.0.2
type WebRTCConfig struct { AdditionalIceServers []*ICEServer `protobuf:"bytes,1,rep,name=additional_ice_servers,json=additionalIceServers,proto3" json:"additional_ice_servers,omitempty"` // disable_trickle indicates if Trickle ICE should be used. Currently, both // sides must both respect this setting. DisableTrickle bool `protobuf:"varint,2,opt,name=disable_trickle,json=disableTrickle,proto3" json:"disable_trickle,omitempty"` // contains filtered or unexported fields }
WebRTCConfig represents parts of a WebRTC config.
func (*WebRTCConfig) Descriptor
deprecated
added in
v0.0.2
func (*WebRTCConfig) Descriptor() ([]byte, []int)
Deprecated: Use WebRTCConfig.ProtoReflect.Descriptor instead.
func (*WebRTCConfig) GetAdditionalIceServers ¶ added in v0.0.2
func (x *WebRTCConfig) GetAdditionalIceServers() []*ICEServer
func (*WebRTCConfig) GetDisableTrickle ¶ added in v0.0.2
func (x *WebRTCConfig) GetDisableTrickle() bool
func (*WebRTCConfig) ProtoMessage ¶ added in v0.0.2
func (*WebRTCConfig) ProtoMessage()
func (*WebRTCConfig) ProtoReflect ¶ added in v0.0.2
func (x *WebRTCConfig) ProtoReflect() protoreflect.Message
func (*WebRTCConfig) Reset ¶ added in v0.0.2
func (x *WebRTCConfig) Reset()
func (*WebRTCConfig) String ¶ added in v0.0.2
func (x *WebRTCConfig) String() string