remote

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2021 License: Apache-2.0 Imports: 31 Imported by: 2

Documentation

Overview

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

Package remote provides access to actors across a network or other I/O connection.

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. **************************************************** 

Package remote is a generated protocol buffer package.

It is generated from these files:
	protos.proto

It has these top-level messages:
	MessageBatch
	MessageEnvelope
	MessageHeader
	ActorPidRequest
	ActorPidResponse
	Unit
	ConnectRequest
	ConnectResponse

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

Index

Constants

This section is empty.

Variables

View Source 
var (
	ActorPidRespErr         interface{} = &ActorPidResponse{StatusCode: ResponseStatusCodeERROR.ToInt32()}
	ActorPidRespTimeout     interface{} = &ActorPidResponse{StatusCode: ResponseStatusCodeTIMEOUT.ToInt32()}
	ActorPidRespUnavailable interface{} = &ActorPidResponse{StatusCode: ResponseStatusCodeUNAVAILABLE.ToInt32()}
)
View Source 
var (
	ErrInvalidLengthProtos = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowProtos   = fmt.Errorf("proto: integer overflow")
)
View Source 
var DefaultSerializerID int32 = 0
View Source 
var ErrActivatorUnavailable = &ActivatorError{ResponseStatusCodeUNAVAILABLE.ToInt32(), true}

ErrActivatorUnavailable : this error will not panic the Activator. It simply tells Partition this Activator is not available Partition will then find next available Activator to spawn

Functions

func ActivatorForAddress 

func ActivatorForAddress(address string) *actor.PID

ActivatorForAddress returns a PID for the activator at the given address

func Deserialize 

func Deserialize(message []byte, typeName string, serializerID int32) (interface{}, error)

func GetKnownKinds 

func GetKnownKinds() []string

GetKnownKinds returns a slice of known actor "kinds"

func Register 

func Register(kind string, props *actor.Props)

Register a known actor props by name

func RegisterRemotingServer 

func RegisterRemotingServer(s *grpc.Server, srv RemotingServer)

func RegisterSerializer 

func RegisterSerializer(serializer Serializer)

func RegisterSerializerAsDefault 

func RegisterSerializerAsDefault(serializer Serializer)

func SendMessage 

func SendMessage(pid *actor.PID, header actor.ReadonlyMessageHeader, message interface{}, sender *actor.PID, serializerID int32)

func Serialize 

func Serialize(message interface{}, serializerID int32) ([]byte, string, error)

func SetLogLevel 

func SetLogLevel(level log.Level)

SetLogLevel sets the log level for the logger.

SetLogLevel is safe to call concurrently

func Shutdown 

func Shutdown(graceful bool)

func SpawnFuture 

func SpawnFuture(address, name, kind string, timeout time.Duration) *actor.Future

SpawnFuture spawns a remote actor and returns a Future that completes once the actor is started

func Start 

func Start(address string, options ...RemotingOption)

Start the remote server

Types

type ActivatorError 

type ActivatorError struct {
	Code       int32
	DoNotPanic bool
}

func (*ActivatorError) Error 

func (e *ActivatorError) Error() string

type ActorPidRequest 

type ActorPidRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
}

func (*ActorPidRequest) Descriptor 

func (*ActorPidRequest) Descriptor() ([]byte, []int)

func (*ActorPidRequest) Equal 

func (this *ActorPidRequest) Equal(that interface{}) bool

func (*ActorPidRequest) GetKind 

func (m *ActorPidRequest) GetKind() string

func (*ActorPidRequest) GetName 

func (m *ActorPidRequest) GetName() string

func (*ActorPidRequest) Marshal 

func (m *ActorPidRequest) Marshal() (dAtA []byte, err error)

func (*ActorPidRequest) MarshalTo 

func (m *ActorPidRequest) MarshalTo(dAtA []byte) (int, error)

func (*ActorPidRequest) ProtoMessage 

func (*ActorPidRequest) ProtoMessage()

func (*ActorPidRequest) Reset 

func (m *ActorPidRequest) Reset()

func (*ActorPidRequest) Size 

func (m *ActorPidRequest) Size() (n int)

func (*ActorPidRequest) String 

func (this *ActorPidRequest) String() string

func (*ActorPidRequest) Unmarshal 

func (m *ActorPidRequest) Unmarshal(dAtA []byte) error

type ActorPidResponse 

type ActorPidResponse struct {
	Pid        *actor.PID `protobuf:"bytes,1,opt,name=pid" json:"pid,omitempty"`
	StatusCode int32      `protobuf:"varint,2,opt,name=status_code,json=statusCode,proto3" json:"status_code,omitempty"`
}

func Spawn 

func Spawn(address, kind string, timeout time.Duration) (*ActorPidResponse, error)

Spawn spawns a remote actor of a given type at a given address

func SpawnNamed 

func SpawnNamed(address, name, kind string, timeout time.Duration) (*ActorPidResponse, error)

SpawnNamed spawns a named remote actor of a given type at a given address

func (*ActorPidResponse) Descriptor 

func (*ActorPidResponse) Descriptor() ([]byte, []int)

func (*ActorPidResponse) Equal 

func (this *ActorPidResponse) Equal(that interface{}) bool

func (*ActorPidResponse) GetPid 

func (m *ActorPidResponse) GetPid() *actor.PID

func (*ActorPidResponse) GetStatusCode 

func (m *ActorPidResponse) GetStatusCode() int32

func (*ActorPidResponse) Marshal 

func (m *ActorPidResponse) Marshal() (dAtA []byte, err error)

func (*ActorPidResponse) MarshalTo 

func (m *ActorPidResponse) MarshalTo(dAtA []byte) (int, error)

func (*ActorPidResponse) ProtoMessage 

func (*ActorPidResponse) ProtoMessage()

func (*ActorPidResponse) Reset 

func (m *ActorPidResponse) Reset()

func (*ActorPidResponse) Size 

func (m *ActorPidResponse) Size() (n int)

func (*ActorPidResponse) String 

func (this *ActorPidResponse) String() string

func (*ActorPidResponse) Unmarshal 

func (m *ActorPidResponse) Unmarshal(dAtA []byte) error

type ConnectRequest 

type ConnectRequest struct {
}

func (*ConnectRequest) Descriptor 

func (*ConnectRequest) Descriptor() ([]byte, []int)

func (*ConnectRequest) Equal 

func (this *ConnectRequest) Equal(that interface{}) bool

func (*ConnectRequest) Marshal 

func (m *ConnectRequest) Marshal() (dAtA []byte, err error)

func (*ConnectRequest) MarshalTo 

func (m *ConnectRequest) MarshalTo(dAtA []byte) (int, error)

func (*ConnectRequest) ProtoMessage 

func (*ConnectRequest) ProtoMessage()

func (*ConnectRequest) Reset 

func (m *ConnectRequest) Reset()

func (*ConnectRequest) Size 

func (m *ConnectRequest) Size() (n int)

func (*ConnectRequest) String 

func (this *ConnectRequest) String() string

func (*ConnectRequest) Unmarshal 

func (m *ConnectRequest) Unmarshal(dAtA []byte) error

type ConnectResponse 

type ConnectResponse struct {
	DefaultSerializerId int32 `protobuf:"varint,1,opt,name=default_serializer_id,json=defaultSerializerId,proto3" json:"default_serializer_id,omitempty"`
}

func (*ConnectResponse) Descriptor 

func (*ConnectResponse) Descriptor() ([]byte, []int)

func (*ConnectResponse) Equal 

func (this *ConnectResponse) Equal(that interface{}) bool

func (*ConnectResponse) GetDefaultSerializerId 

func (m *ConnectResponse) GetDefaultSerializerId() int32

func (*ConnectResponse) Marshal 

func (m *ConnectResponse) Marshal() (dAtA []byte, err error)

func (*ConnectResponse) MarshalTo 

func (m *ConnectResponse) MarshalTo(dAtA []byte) (int, error)

func (*ConnectResponse) ProtoMessage 

func (*ConnectResponse) ProtoMessage()

func (*ConnectResponse) Reset 

func (m *ConnectResponse) Reset()

func (*ConnectResponse) Size 

func (m *ConnectResponse) Size() (n int)

func (*ConnectResponse) String 

func (this *ConnectResponse) String() string

func (*ConnectResponse) Unmarshal 

func (m *ConnectResponse) Unmarshal(dAtA []byte) error

type EndpointConnectedEvent 

type EndpointConnectedEvent struct {
	Address string
}

type EndpointTerminatedEvent 

type EndpointTerminatedEvent struct {
	Address string
}

type JsonMessage 

type JsonMessage struct {
	TypeName string
	Json     string
}

type MessageBatch 

type MessageBatch struct {
	TypeNames   []string           `protobuf:"bytes,1,rep,name=type_names,json=typeNames" json:"type_names,omitempty"`
	TargetNames []string           `protobuf:"bytes,2,rep,name=target_names,json=targetNames" json:"target_names,omitempty"`
	Envelopes   []*MessageEnvelope `protobuf:"bytes,3,rep,name=envelopes" json:"envelopes,omitempty"`
}

func (*MessageBatch) Descriptor 

func (*MessageBatch) Descriptor() ([]byte, []int)

func (*MessageBatch) Equal 

func (this *MessageBatch) Equal(that interface{}) bool

func (*MessageBatch) GetEnvelopes 

func (m *MessageBatch) GetEnvelopes() []*MessageEnvelope

func (*MessageBatch) GetTargetNames 

func (m *MessageBatch) GetTargetNames() []string

func (*MessageBatch) GetTypeNames 

func (m *MessageBatch) GetTypeNames() []string

func (*MessageBatch) Marshal 

func (m *MessageBatch) Marshal() (dAtA []byte, err error)

func (*MessageBatch) MarshalTo 

func (m *MessageBatch) MarshalTo(dAtA []byte) (int, error)

func (*MessageBatch) ProtoMessage 

func (*MessageBatch) ProtoMessage()

func (*MessageBatch) Reset 

func (m *MessageBatch) Reset()

func (*MessageBatch) Size 

func (m *MessageBatch) Size() (n int)

func (*MessageBatch) String 

func (this *MessageBatch) String() string

func (*MessageBatch) Unmarshal 

func (m *MessageBatch) Unmarshal(dAtA []byte) error

type MessageEnvelope 

type MessageEnvelope struct {
	TypeId        int32          `protobuf:"varint,1,opt,name=type_id,json=typeId,proto3" json:"type_id,omitempty"`
	MessageData   []byte         `protobuf:"bytes,2,opt,name=message_data,json=messageData,proto3" json:"message_data,omitempty"`
	Target        int32          `protobuf:"varint,3,opt,name=target,proto3" json:"target,omitempty"`
	Sender        *actor.PID     `protobuf:"bytes,4,opt,name=sender" json:"sender,omitempty"`
	SerializerId  int32          `protobuf:"varint,5,opt,name=serializer_id,json=serializerId,proto3" json:"serializer_id,omitempty"`
	MessageHeader *MessageHeader `protobuf:"bytes,6,opt,name=message_header,json=messageHeader" json:"message_header,omitempty"`
}

func (*MessageEnvelope) Descriptor 

func (*MessageEnvelope) Descriptor() ([]byte, []int)

func (*MessageEnvelope) Equal 

func (this *MessageEnvelope) Equal(that interface{}) bool

func (*MessageEnvelope) GetMessageData 

func (m *MessageEnvelope) GetMessageData() []byte

func (*MessageEnvelope) GetMessageHeader 

func (m *MessageEnvelope) GetMessageHeader() *MessageHeader

func (*MessageEnvelope) GetSender 

func (m *MessageEnvelope) GetSender() *actor.PID

func (*MessageEnvelope) GetSerializerId 

func (m *MessageEnvelope) GetSerializerId() int32

func (*MessageEnvelope) GetTarget 

func (m *MessageEnvelope) GetTarget() int32

func (*MessageEnvelope) GetTypeId 

func (m *MessageEnvelope) GetTypeId() int32

func (*MessageEnvelope) Marshal 

func (m *MessageEnvelope) Marshal() (dAtA []byte, err error)

func (*MessageEnvelope) MarshalTo 

func (m *MessageEnvelope) MarshalTo(dAtA []byte) (int, error)

func (*MessageEnvelope) ProtoMessage 

func (*MessageEnvelope) ProtoMessage()

func (*MessageEnvelope) Reset 

func (m *MessageEnvelope) Reset()

func (*MessageEnvelope) Size 

func (m *MessageEnvelope) Size() (n int)

func (*MessageEnvelope) String 

func (this *MessageEnvelope) String() string

func (*MessageEnvelope) Unmarshal 

func (m *MessageEnvelope) Unmarshal(dAtA []byte) error

type MessageHeader 

type MessageHeader struct {
	HeaderData map[string]string `` /* 172-byte string literal not displayed */
}

func (*MessageHeader) Descriptor 

func (*MessageHeader) Descriptor() ([]byte, []int)

func (*MessageHeader) Equal 

func (this *MessageHeader) Equal(that interface{}) bool

func (*MessageHeader) GetHeaderData 

func (m *MessageHeader) GetHeaderData() map[string]string

func (*MessageHeader) Marshal 

func (m *MessageHeader) Marshal() (dAtA []byte, err error)

func (*MessageHeader) MarshalTo 

func (m *MessageHeader) MarshalTo(dAtA []byte) (int, error)

func (*MessageHeader) ProtoMessage 

func (*MessageHeader) ProtoMessage()

func (*MessageHeader) Reset 

func (m *MessageHeader) Reset()

func (*MessageHeader) Size 

func (m *MessageHeader) Size() (n int)

func (*MessageHeader) String 

func (this *MessageHeader) String() string

func (*MessageHeader) Unmarshal 

func (m *MessageHeader) Unmarshal(dAtA []byte) error

type RemotingClient 

type RemotingClient interface {
	Connect(ctx context.Context, in *ConnectRequest, opts ...grpc.CallOption) (*ConnectResponse, error)
	Receive(ctx context.Context, opts ...grpc.CallOption) (Remoting_ReceiveClient, error)
}

func NewRemotingClient 

func NewRemotingClient(cc *grpc.ClientConn) RemotingClient

type RemotingOption 

type RemotingOption func(*remoteConfig)

RemotingOption configures how the remote infrastructure is started

func WithCallOptions 

func WithCallOptions(options ...grpc.CallOption) RemotingOption

func WithDialOptions 

func WithDialOptions(options ...grpc.DialOption) RemotingOption

func WithEndpointManagerBatchSize 

func WithEndpointManagerBatchSize(batchSize int) RemotingOption

func WithEndpointManagerQueueSize 

func WithEndpointManagerQueueSize(queueSize int) RemotingOption

func WithEndpointWriterBatchSize 

func WithEndpointWriterBatchSize(batchSize int) RemotingOption

func WithEndpointWriterQueueSize 

func WithEndpointWriterQueueSize(queueSize int) RemotingOption

func WithServerOptions 

func WithServerOptions(options ...grpc.ServerOption) RemotingOption

type RemotingServer 

type RemotingServer interface {
	Connect(context.Context, *ConnectRequest) (*ConnectResponse, error)
	Receive(Remoting_ReceiveServer) error
}

type Remoting_ReceiveClient 

type Remoting_ReceiveClient interface {
	Send(*MessageBatch) error
	Recv() (*Unit, error)
	grpc.ClientStream
}

type Remoting_ReceiveServer 

type Remoting_ReceiveServer interface {
	Send(*Unit) error
	Recv() (*MessageBatch, error)
	grpc.ServerStream
}

type ResponseStatusCode 

type ResponseStatusCode int32
const (
	ResponseStatusCodeOK ResponseStatusCode = iota
	ResponseStatusCodeUNAVAILABLE
	ResponseStatusCodeTIMEOUT
	ResponseStatusCodePROCESSNAMEALREADYEXIST
	ResponseStatusCodeERROR
)

func (ResponseStatusCode) ToInt32 

func (c ResponseStatusCode) ToInt32() int32

type Serializer 

type Serializer interface {
	Serialize(msg interface{}) ([]byte, error)
	Deserialize(typeName string, bytes []byte) (interface{}, error)
	GetTypeName(msg interface{}) (string, error)
}

type Unit 

type Unit struct {
}

func (*Unit) Descriptor 

func (*Unit) Descriptor() ([]byte, []int)

func (*Unit) Equal 

func (this *Unit) Equal(that interface{}) bool

func (*Unit) Marshal 

func (m *Unit) Marshal() (dAtA []byte, err error)

func (*Unit) MarshalTo 

func (m *Unit) MarshalTo(dAtA []byte) (int, error)

func (*Unit) ProtoMessage 

func (*Unit) ProtoMessage()

func (*Unit) Reset 

func (m *Unit) Reset()

func (*Unit) Size 

func (m *Unit) Size() (n int)

func (*Unit) String 

func (this *Unit) String() string

func (*Unit) Unmarshal 

func (m *Unit) Unmarshal(dAtA []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.