Click or drag to resize

DataConnectorPipeClientTCommand Class

The base class for the ScoringProgram pipe client and the BCS pipe client (not in this code base). Used to connect to and disconnect from the Data Connector.
Inheritance Hierarchy
SystemObject
  BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientDataConnectorPipeClientTCommand
    BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientScoringProgramPipeClient

Namespace: BridgeSystems.Bridgemate.DataConnector.ScoringProgramClient
Assembly: BridgeSystems.Bridgemate.DataConnector.ScoringProgramClient (in BridgeSystems.Bridgemate.DataConnector.ScoringProgramClient.dll) Version: 1.0.923.1+8676f6447fd14feb672ed9c066f2812915b8f069
Syntax
C#
public abstract class DataConnectorPipeClient<TCommand> : IDisposable
where TCommand : Enum

Type Parameters

TCommand

The DataConnectorPipeClientTCommand type exposes the following members.

Constructors
 NameDescription
Protected methodDataConnectorPipeClientTCommand Initializes the class.
Top
Properties
 NameDescription
Protected propertyDataConnectorReader The class that reads data from the pipe stream. Can and must be disposed.
Protected propertyDataConnectorStream The underlying pipe stream for both the writer and the reader. Can and must be disposed.
Protected propertyDataConnectorWriter The class that writes data over the pipe stream. Can and must be disposed.
Public propertyIsActive Can be used to see if there already is a connection to the Data Connector. If so, do not try to connect again.
Protected propertyLoggingSource The source for the logging: Client or Server, BCS or ScoringProgram.
Public propertyTimeOutInMilliSeconds The timeout for establishing a connection with the Data Connector. If not set the default value DefaultTimeOutInMilliSeconds will be used.
Top
Methods
 NameDescription
Protected methodCloseConnection Disposes of the NamedPipeClientStream that channels messages to and from the DataConnector.
Protected methodCloseReader Disposes of the StreamReader class that reads messages from the DataConnector.
Protected methodCloseWriter Disposes of the StreamWriter class that sends messages to the DataConnector.
Protected methodConnect Connects to the specified named pipe synchronously.
Protected methodConnectAsync Connects to the specified named pipe asynchronously.
Public methodDispose Disposes the class.
Protected methodDispose(Boolean) Disposes the stream, writer and reader for the DataConnector if disposing is not already in progress.
Protected methodLogError Logs an error
Protected methodLogMethodEntry(String) Logs the entry to a method.
Protected methodLogMethodEntry(String, ValueTupleString, Object) Logs the entry to a method with its parameters (if any),
Top
Fields
 NameDescription
Public fieldDataConnectorClientLogger NLog implementation of logging.
Top
See Also