Struct RemoteServiceConnectionInfo

Namespace

Microsoft.ServiceHub.Framework

Assembly

Microsoft.ServiceHub.Framework.dll

Describes how to connect to a provisioned remote service.

public struct RemoteServiceConnectionInfo

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

An initialized instance of this struct is expected to represent exactly one connection mechanism.

Properties

ClrActivation

Gets or sets instructions to activate the service within the client process.

public RemoteServiceConnectionInfo.LocalCLRServiceActivation ClrActivation { readonly get; set; }

Property Value

RemoteServiceConnectionInfo.LocalCLRServiceActivation

IsEmpty

Gets a value indicating whether this instance represents no connection information.

[JsonIgnore]
public bool IsEmpty { get; }

Property Value

bool

MultiplexingChannelId

Gets or sets the ID of the channel created over the remote service broker's multiplexing stream where the activated service is listening.

public ulong? MultiplexingChannelId { readonly get; set; }

Property Value

ulong?

PipeName

Gets or sets the name of an IPC pipe to connect to where the activated service is listening. On Windows this is a named pipe, whereas on OSX/Linux this is the path to a unix domain socket.

public string? PipeName { readonly get; set; }

Property Value

string

RequestId

Gets or sets the ID assigned to the service request that this instance is in response to.

public Guid? RequestId { readonly get; set; }

Property Value

Guid?

Remarks

This value is useful when canceling this service request without connecting to it. If null, no resources are allocated for this service prior to the client connecting to it, and thus no resources need to be released if the client decides not to connect.

Methods

IsOneOf(RemoteServiceConnections)

Checks whether this instance contains instructions for any of a set of connection types.

public bool IsOneOf(RemoteServiceConnections connections)

Parameters

connections RemoteServiceConnections

The set of connection types to test for.

Returns

bool

true if any of the connections specified coincide with instructions available in this value; false otherwise. false is returned if connections is set to None.