 | Scoring |
Exchanges information with the dataconnector using http.
Inheritance HierarchySystemObject
BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientDataConnectorClientCommandManagerScoringProgramDataConnectorCommands
BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientScoringProgramDataConnectorClientCommandManager
BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientScoringProgramDataConnectorHttpClient
BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientDataConnectorClientCommandManagerScoringProgramDataConnectorCommands
BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientScoringProgramDataConnectorClientCommandManager
BridgeSystems.Bridgemate.DataConnector.ScoringProgramClientScoringProgramDataConnectorHttpClient
Namespace: BridgeSystems.Bridgemate.DataConnector.ScoringProgramClient
Assembly: BridgeSystems.Bridgemate.DataConnector.ScoringProgramClient (in BridgeSystems.Bridgemate.DataConnector.ScoringProgramClient.dll) Version: 5.0.1014.1+c0d6f9bc4d7d415f4cee902c0a8eb3b5237ddd44
SyntaxC#
public class ScoringProgramDataConnectorHttpClient : ScoringProgramDataConnectorClientCommandManager, IScoringProgramClient
The ScoringProgramDataConnectorHttpClient type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | ApiUrlRoot | Constructs the full url for the webservice based on whether it is hosted in local host or in the cloud. |
| Credentials | The information needed to get access to the http channel for the data communicator. |
| IsActive |
Always returns true.
(Overrides DataConnectorClientCommandManagerTCommandIsActive) |
| IsSending |
Only one request can be sent at the same time. So let asynchronous code always check, set and reset this
property before, while and after sending a request. Feel free to make more nifty implementations.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LastHandrecordQueueItemId |
The id of the last handrecord queue item downloaded from the Data Connector.
You can use this to internally accept this item (and all before of the same type).
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LastParticipantQueueItemId |
The id of the last participant queue item downloaded from the Data Connector.
You can use this to internally accept this item (and all before of the same type).
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LastPlayerDataQueueItemId |
The id of the last player data queue item downloaded from the Data Connector.
You can use this to internally accept this item (and all before of the same type).
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LastResultQueueItemId |
The id of the last result queue item downloaded from the Data Connector.
You can use this to internally accept this item (and all before of the same type).
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LoggingSource |
The source of the logging records.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| TimeOutInMilliSeconds |
The timeout for establishing a connection with the Data Connector.
If not set the default value DefaultTimeOutInMilliSeconds will be used.
(Inherited from DataConnectorClientCommandManagerTCommand) |
| UseLocalHost | If set to true will make the client communicate with the local host hosted webservice. Used for debugging only. |
Methods| Name | Description | |
|---|---|---|
 | AcceptQueueData |
Signals to the Data Connector synchronously that a specific type of queuedata up to the specified id does not need to be sent again.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| AcceptQueueDataAsync |
Signals to the Data Connector asynchronously that a specific type of queuedata up to the specified id does not need to be sent again.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| AddSession |
Adds the given session to a known event synchronously.
This event must have been sent to the Data Connector previously using an InitDTO.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| AddSessionAsync |
Adds the given session to a known event asynchronously.
This event must have been sent to the Data Connector previously using an InitDTO.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| ClearData |
Instructs the DataConnector to synchronously clear all incoming and outgoing queuedata and to remove al validation data as well.
Use with caution!
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| ClearDataAsync |
Instructs the DataConnector to asynchronously clear all incoming and outgoing queuedata and to remove al validation data as well.
Use with caution!
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| Connect | Checks if the endpoint can be reached by sending a ping request to it. |
| Connect(String) |
Not implemented for http.
(Overrides DataConnectorClientCommandManagerTCommandConnect(String)) |
| ConnectAsync | Checks if the endpoint can be reached by sending a ping request to it. |
| ConnectAsync(String) |
Not implemented for http.
(Overrides DataConnectorClientCommandManagerTCommandConnectAsync(String)) |
| Continue |
Instructs BCS synchronously to continue working with a previously created event.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| ContinueAsync |
Instructs BCS asynchronously to continue working with a previously created event.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| Disconnect | Not implemented for http. |
| DisconnectAsync | Not implemented for http. |
| Dispose | Releases all resources used by the ScoringProgramDataConnectorHttpClient |
 | Dispose(Boolean) | Releases the unmanaged resources used by the ScoringProgramDataConnectorHttpClient and optionally releases the managed resources (Overrides DataConnectorClientCommandManagerTCommandDispose(Boolean)) |
| DoesSessionExist |
Does an synchronous check on if the session with the given guid exists.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| DoesSessionExistAsync |
Does an asynchronous check on if the session with the given guid exists.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| GetAllMovements |
Returns the movements synchronously for the given session as they are in use by BCS.Mind that the Data Connector itself creates updates to
enact movement changes.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| GetAllMovementsAsync |
Returns the movements asynchronously for the given session as they are in use by BCS.Mind that the Data Connector itself creates updates to
enact movement changes.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| GetMovement |
Returns the movement for the given section synchronously as it is in use by BCS.Mind that the Data Connector itself creates updates to
enact movement changes.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| GetMovementAsync |
Returns the movement asynchronously for the given section as it is in use by BCS.Mind that the Data Connector itself creates updates to
enact movement changes.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| Initialize |
Instructs BCS to create a new sessions with the provided table domain data (scoring groups, sections, tables, rounds).
Player names, Results and Handrecords can be included or can be uploaded later. The latter option is considerably less performant.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| InitializeAsync |
Instructs BCS to create new sessions with the provided table domain data (scoring groups, sections, tables, rounds).
Player names, Results and Handrecords can be included or can be uploaded later. The latter option is considerably less performant.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| Instance | Returns the singleton instance of the client with its ClubdId and LicenceKey properties set to the values of the parameters. |
| IsServiceAlive | |
| IssueManagementCommand |
Issue a management command to BCS synchronously. This command can either be a query for information on the location of its scoring file, which sessions
it is currently administering or which sessions are know to it, or it can be an instruction to shut down.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| IssueManagementCommandAsync |
Issue a management command to BCS asynchronously. This command can either be a query for information on the location of its scoring file, which sessions
it is currently administering or which sessions are known to it, or it can be an instruction to shut down.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LogError |
Logs an exception.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LogMethodEntry(String) |
Logs the entry to a method with its parameters (if any).
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| LogMethodEntry(String, ValueTupleString, Object) |
Logs the entry to a method with its parameters (if any),
(Inherited from DataConnectorClientCommandManagerTCommand) |
| Ping |
Communicates to the Data Connector synchronously to see if it is responsive.
This is done by sending a random piece of data and checking of the Data Connector returns it.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PingAsync |
Communicates to the Data Connector asynchronously to see if it is responsive.
This is done by sending a random piece of data and checking of the Data Connector returns it.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForHandrecords |
Polls the Data Connector synchronously for new handrecords for the session,
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForHandrecordsAsync |
Polls the Data Connector asynchronously for new handrecords for the session,
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForParticipations |
Polls the client queue synchronously for new participations for the specified session.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForParticipationsAsync |
Polls the client queue asynchronously for new participations for the specified session.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForPlayerData |
Polls the client queue asynchronously for new player data for the specified session.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForPlayerDataAsync |
Polls the client queue asynchronously for new player data for the specified session.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForResults |
Polls the client queue for new boardresults synchronously.
Required. The guid of the session to poll participations for.Poll all results for the session, included ones polled before. (Inherited from ScoringProgramDataConnectorClientCommandManager) |
| PollForResultsAsync |
Polls the client queue for new boardresults asynchronously.
Required. The guid of the session to poll participations for.Poll all results for the session, included ones polled before. (Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendBridgemate2Settings |
Adds or updates the Bridgemate 2 settings for the given sections synchronously. There can and must be one dto per section.
The section letters cannot be left out!
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendBridgemate2SettingsAsync |
Adds or updates the Bridgemate 2 settings for the given sections asynchronously. There can and must be one dto per section.
The section letters cannot be left out.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendBridgemate3Settings |
Adds or updates the Bridgemate 3 settings for the given sections synchronously. There can and must be one dto per section.
The section letters cannot be left out!
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendBridgemate3SettingsAsync |
Adds or updates the Bridgemate 3 settings for the given sections asynchronously. There can and must be one dto per section.
The section letters cannot be left out!
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendData |
The code that handles the actual sending of requests and reading their reponses.
(Overrides ScoringProgramDataConnectorClientCommandManagerSendData(String, ScoringProgramDataConnectorCommands, String, String)) |
| SendDataAsync |
The code that handles the actual sending of requests and reading their reponses.
(Overrides ScoringProgramDataConnectorClientCommandManagerSendDataAsync(String, ScoringProgramDataConnectorCommands, String, String)) |
| SendHandrecords |
Sends handrecords synchronously to the BCS queue.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendHandrecordsAsync |
Sends handrecords asynchronously to the BCS queue.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendParticipations |
Sends participations asynchronously to the BCS queue.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendParticipationsAsync |
Sends participations asynchronously to the BCS queue.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendPlayerData |
Sends PlayerData synchronously to the BCS queue.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendPlayerDataAsync |
Sends PlayerData asynchronously to the BCS queue.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendResults |
Sends boardresults synchronously to the BCS queue
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| SendResultsAsync |
Sends boardresults asynchronously to the BCS queue
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| UpdateMovement |
Instructs BCS synchronously to update the movement for the given section. Be sure to include the movement for the section after its change.
BCS will figure out how to adjust its data to enact the change.
Mind that board results will be erased for each table starting from the lowest numbered round with different round data.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| UpdateMovementAsync |
Instructs BCS asynchronously to update the movement for the given section. Be sure to include the movement for the section after its change.
BCS will figure out how to adjust its data to enact the change.
Mind that board results will be erased for each table starting from the lowest numbered round with different round data.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| UpdateScoringGroups |
Instructs BCS synchronously to update the scoringgroups. This can be done to change the scoring method or to rearrange the sections that are attached to them.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
| UpdateScoringGroupsAsync |
Instructs BCS asynchronously to update the scoringgroups. This can be done to change the scoring method or to rearrange the sections that are attached to them.
(Inherited from ScoringProgramDataConnectorClientCommandManager) |
Fields| Name | Description | |
|---|---|---|
 | ApiCall | The url to call when the scoring program communicates with the data connector. |
| ApiPingResponse | Part of the expected response from the webservice when sending a Get httprequest to it. |
| ApiUrlRootWihtoutProtocol | Constructs the url for the webservice without the http:// prefix based on whether it is hosted in local host or in the cloud. |
| DataConnectorClientLogger |
NLog implementation of logging.
(Inherited from DataConnectorClientCommandManagerTCommand) |
 | DebugLogger | The debug logger |
| ErrorLogger | The error logger |
| LocalHostUrl | The full url for the local host hosted webservice. Used for debugging only. |
| LocalHostUrlWithoutProtocol | The url for the local host hosted webservice without the http:// prefix. Used for debugging only. |
| ProductionUrl | The full url for the webservice. |
| ProductionUrlWithouProtocol | The url for the webservice without the http:// prefix. |
See Also