The main class used to connect to the Tracking Server gateway.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class Connector
Public Class Connector
public ref class Connector
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | Connector()()()() |
The constructor.
|
 | ActionListResponse |
Event to signal that a response to action list request has been received.
|
| AuthenticateAsync(String, String) |
Authenticates with the Tracking Server using the provided username and password.
The AuthenticateResponse
event will be raised upon completion or error.
|
| AuthenticateResponse |
Event to signal that a response to authenticate request has been received.
|
| AuxiliaryDataReceived |
Event to signal that auxiliary data has been received.
|
| ConnectAsync(String, Int32) |
Connects to given remoteHostname at given port.
The ConnectResponse
event will be raised upon completion or error.
|
| ConnectResponse |
Event to signal that a response to connect request has been received.
|
| DisconnectAsync(Boolean) |
Disconnects connection and closes socket to gateway.
The DisconnectResponse
event will be raised upon completion or error.
|
| DisconnectResponse |
Event to signal that a response to a disconnect request has been received.
|
| GatewayDataReceived |
Event to signal that Gateway Data was received.
|
| GeneralError |
Event to signal that a general error has occurred.
|
| GetActionListAsync()()()() |
Sends a request to the Tracking Server for available actions.
The ActionListResponse
event will be raised upon completion or error.
|
| GetAuxiliaryDataAsync(String) |
Sends a request to the Tracking Server for the auxiliary data of a complex service.
The AuxiliaryDataReceived
event will be raised when data is received.
|
| GetGatewayStatisticsAsync(List<(Of <<'(GatewayStatisticsType>)>>)) |
Sends a request to the gateway for Gateway Statistics.
The GatewayDataReceived
event will be raised upon completion or error.
|
| GetServiceDefinitionsAsync()()()() |
Sends a request to the Tracking Server for service definitions available to the current user.
The ServiceDefinitionsResponse
event will be raised upon completion or error.
|
| GetServiceNames()()()() |
Gets most recent list of services available.
|
| GetSubscribedServiceNames()()()() |
Gets the list of subscribed services.
|
| GetSymbolFromIDAsync(String, Int32, Boolean) |
Sends a request to the Tracking Server for a symbol. If requesting a MOLE symbol,
MOLE must be installed on the Tracking Server. Currently only MOLE symbol are supported.
The SymbolResponse
event will be raised upon completion or error.
|
| GetSymbolFromXMLAsync(String, Boolean) |
Sends a request to the Tracking Server for a symbol. If requesting a MOLE symbol,
MOLE must be installed on the Tracking Server. Currently only MOLE symbol are supported.
The SymbolResponse
event will be raised upon completion or error.
|
| GetUnsubscribedServiceNames()()()() |
Gets the list of unsubscribed services.
|
 | IsConnected |
Indicates whether the socket connection is open or not.
|
| IsLoggedIn |
Indicates whether or not currently logged in to the Tracking Server.
|
| MessageFormatManager |
Gets most recent MessageFormatManager returned by the Tracking Server.
|
| ObservationReceived |
Event to signal that an observation has been received.
|
| Password |
Gets password used to log in.
|
| Port |
Gets port number used to connect.
|
| RemoteHostname |
Gets remote hostname used to connect.
|
| ServiceDefinitionsResponse |
Event to signal that a response to a service definitions request has been received.
|
| SetAOIForServiceAsync(String, TmsEnvelope, SetAOIType) |
Set an envelope area of interest for a service
|
| SetAOIResponse |
Event to signal that a response to a set AOI request has been received.
|
| SubscribeResponse |
Event to signal that a response to a subscribe request has been received.
|
| SubscribeToServiceAsync(String) |
Sends a request to the gateway to subscribe to a single service.
The SubscribeResponse
event will be raised upon completion or error.
|
| SubscribeToServiceListAsync(List<(Of <<'(String>)>>)) |
Sends a request to the gateway to subscribe to a list of services.
The SubscribeResponse
event will be raised upon completion or error.
|
| SymbolResponse |
Event to signal that a response to a symbol request has been received.
|
| UnsubscribeFromServiceAsync(String) |
Sends a request to the gateway to unsubscribe from a single service.
The UnsubscribeResponse
event will be raised upon completion or error.
|
| UnsubscribeFromServiceListAsync(List<(Of <<'(String>)>>)) |
Sends a request to the gateway to unsubscribe from a list of services.
The UnsubscribeResponse
event will be raised upon completion or error.
|
| UnsubscribeResponse |
Event to signal that a response to an unsubscribe request has been received.
|
| Username |
Gets username used to log in.
|
Inheritance Hierarchy| Object | |
 | Connector |