C# Class AK.F1.Timing.F1Timing.Live

Provides methods for creating AK.F1.Timing.IMessageReaders which read from the live-timing message stream.
Mostrar archivo Open project: simoneb/ak-f1-timing

Public Methods

Method Description
Login ( string username, string password ) : AuthenticationToken

Logs into the live-timing service using the specified credentials.
Read ( AuthenticationToken token ) : IMessageReader

Creates a live-timing message reader using the specified authentication token.
ReadAndRecord ( AuthenticationToken token, string path ) : IMessageReader

Creates a live message reader using the specified authentication token and records the messages to the specified path.

Method Details

Login() public static method

Logs into the live-timing service using the specified credentials.
/// Thrown when or is /// . /// /// Thrown when or is empty. /// /// Thrown when an IO error whilst connecting to the live messages stream. /// /// Thrown when the supplied credentials were rejected by the live-timing site. ///
public static Login ( string username, string password ) : AuthenticationToken
username string The user's F1 live-timing username.
password string The user's F1 live-timing password.
return AuthenticationToken

Read() public static method

Creates a live-timing message reader using the specified authentication token.
/// Thrown when is . /// /// Thrown when an IO error whilst connecting to the live-timing message stream. ///
public static Read ( AuthenticationToken token ) : IMessageReader
token AuthenticationToken The authentication token.
return IMessageReader

ReadAndRecord() public static method

Creates a live message reader using the specified authentication token and records the messages to the specified path.
/// Thrown when or is /// . /// /// Thrown when is of zero length. /// /// Thrown when an IO error occurs whilst creating the output file or connecting to the /// live-timing message stream. ///
public static ReadAndRecord ( AuthenticationToken token, string path ) : IMessageReader
token AuthenticationToken The authentication token.
path string The path to save the messages to.
return IMessageReader