Class PetabridgeCmdClient

ActorSystem extension for creating remote IPbmClient instances.

Inheritance

object

PetabridgeCmdClient

Implements

IExtension

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Petabridge.Cmd.Common.Client

Assembly: Petabridge.Cmd.Common.dll

Syntax

public sealed class PetabridgeCmdClient : IExtension

Properties

Sys

Declaration

public ExtendedActorSystem Sys { get; }

Property Value

Type	Description
ExtendedActorSystem

Methods

Get(ActorSystem)

Retrieves the instance of the PetabridgeCmd plugin for a given ActorSystem.

Declaration

public static PetabridgeCmdClient Get(ActorSystem sys)

Parameters

Type	Name	Description
ActorSystem	sys	The actor system that this petabridge.cmd host will run on.

Returns

Type	Description
PetabridgeCmdClient	A singleton instance of the petabridge.cmd host.

StartRemoteClient(EndPoint)

Starts a remote IPbmClient that can be used to interact programmatically with a PetabridgeCmd instance running on a remote host.

This client can be used over and over again until IsAvailable is no longer true, which happens when the IPbmClient is disposed or when the actors it depends upon are terminated, typically via ActorSystem termination or when the remote TCP connection is closed.

Declaration

public Task<IPbmClient> StartRemoteClient(EndPoint pbmHost)

Parameters

Type	Name	Description
EndPoint	pbmHost	A DnsEndPoint or IPEndPoint that contains an open PetabridgeCmd host.

Returns

Type	Description
Task<IPbmClient>	A remote IPbmClient instance.

StartRemoteClient(EndPoint, CancellationToken)

Starts a remote IPbmClient that can be used to interact programmatically with a PetabridgeCmd instance running on a remote host.

This client can be used over and over again until IsAvailable is no longer true, which happens when the IPbmClient is disposed or when the actors it depends upon are terminated, typically via ActorSystem termination or when the remote TCP connection is closed.

Declaration

public Task<IPbmClient> StartRemoteClient(EndPoint pbmHost, CancellationToken token)

Parameters

Type	Name	Description
EndPoint	pbmHost	A DnsEndPoint or IPEndPoint that contains an open PetabridgeCmd host.
CancellationToken	token	A cancellation token

Returns

Type	Description
Task<IPbmClient>	A remote IPbmClient instance.

Implements

IExtension