Class PipesClient

Client using named pipes

Inheritance

object

Client

PipesClient

Implements

IDisposable

Inherited Members

Client.DefaultBufferSize

Client.TypeReaderWriterManager

Client.IsConnected

Client.AddService<T>()

Client.AddService(Type)

Client.SetProtocolVersion(object)

Client.HasDisposed

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VoltRpc.Communication.Pipes

Assembly: VoltRpc.Communication.Pipes.dll

Syntax

public sealed class PipesClient : Client, IDisposable

Constructors

| Edit this page View Source

PipesClient(string, int)

Creates a new PipesClient instance

Declaration

public PipesClient(string pipeName, int bufferSize = 8000)

Parameters

Type	Name	Description
string	pipeName	The name of the pipe
int	bufferSize	The size of the buffers

| Edit this page View Source

PipesClient(string, int, int)

Creates a new PipesClient instance

Declaration

public PipesClient(string pipeName, int connectionTimeout, int bufferSize = 8000)

Parameters

Type	Name	Description
string	pipeName	The name of the pipe
int	connectionTimeout	The timeout for connection
int	bufferSize	The size of the buffers

| Edit this page View Source

PipesClient(string, string, int)

Creates a new PipesClient instance

Declaration

public PipesClient(string server, string pipeName, int bufferSize = 8000)

Parameters

Type	Name	Description
string	server	The server to connect to
string	pipeName	The name of the pipe
int	bufferSize	The size of the buffers

| Edit this page View Source

PipesClient(string, string, int, int)

Creates a new PipesClient instance

Declaration

public PipesClient(string server, string pipeName, int connectionTimeout, int bufferSize = 8000)

Parameters

Type	Name	Description
string	server	The server to connect to
string	pipeName	The name of the pipe
int	connectionTimeout	The timeout for connection
int	bufferSize	The size of the buffers

Fields

| Edit this page View Source

DefaultConnectionTimeout

Default connection timeout time

Declaration

public const int DefaultConnectionTimeout = 7000

Field Value

Type	Description
int

Methods

| Edit this page View Source

Connect()

Connects the Client to a host

Declaration

public override void Connect()

Overrides

Client.Connect()

Exceptions

Type	Condition
ConnectionFailedException	Thrown if an error occurs while connecting.

| Edit this page View Source

Dispose()

Destroys the Client instance

Declaration

public override void Dispose()

Overrides

Client.Dispose()

Implements

IDisposable