 | Bridge |
Classes| Class | Description | |
|---|---|---|
 | DataConnectorLogCreatorTCommand | Logs all actions of the DataConnector in a structured way. |
| DataConnectorPipeClientTCommand | 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. |
| ScoringProgramDataConnectorLogCreator | Structured logger for the scoring program side of data communicator communication |
| ScoringProgramHttpClient | WARN: Currently not supported. Uses the Http protocol to communicate with the Data Connector. |
| ScoringProgramPipeClient |
Handles request from the scoring programs. This code is freely available for external programmers to adapt to their
specific needs. This code, however, is guaranteed to work. Interop options are available for many programming languages.
Note that this class is written as a singleton: there should never be more than one instance communicating over the pipe. The constructor is protected however, so by inheriting from this class a non singleton instance can be used. The class implements IDispable through its base class, as the base class contains a stream writer and stream reader that must be disposed when the communication shuts down. Be sure to call Dispose on the class any time it is no longer in use, otherwise communication will stall. The code has no dependencies, except one on NLog. If you decide to copy the code make sure to add a dependency to the NLog NuGet package or implement your own logging.The logger is defined in the base class and is named "DataConnectorClientLogger". All public functions have synchronous and asynchronous implementation (ending in "Async"). To get started inspect the following functions: Connect and ConnectAsync: Connection to the Data Connector. Initialize and InitializeAsync: Initialization of a new event. IssueManagementCommand and IssueManagementCommandAsync: Query the Bridgemate Control Software. |
| ScoringProgramRequest | This class carries both a command and its associated data (if any) for the Data Connector. If the command pertains to a specific session the SessionGuid property has to be set. Validation will check in that case if the SessionGuid properties of the SerializedData has the same value. The Data Connector always responds with a ScoringProgramResponse |
| ScoringProgramResponse | This class carries the response data that the Data Connector sends back after sending it a ScoringProgramRequest. |
Structures| Structure | Description | |
|---|---|---|
 | DataConnectorLogCreatorTCommandDataConnectorLogRecord | Contains the structured information |
Enumerations| Enumeration | Description | |
|---|---|---|
 | DataConnectorLoggingSource | The source of the log message |
| DataConnectorLogLevel | The log level |
| DataConnectorResponseData | Specifies the data type that the ScoringProgramResponse's SerializedData property should contain. |
| ErrorType | Clarifies what type of error occurred, causing the ScoringProgramRequest to fail. |
| ScoringProgramDataConnectorCommands | These enum values comprise the command values that can be set on the ScoringProgramRequest's Command property. Not all of these are currently supported. In the comments after the values the associated Data Transfer Object (DTO) is mentioned if applicable. |