Telnet Factory for .NET

TelnetTask Members

TelnetTask overview

Public Static Fields

ACTIVETelnetTask is active and waiting for start prompt to execute command.
CANCELLEDTelnetTask was cancelled by user or due to a timeout.
COMPLETETelnetTask has finished execution of command and has received end prompt.
PENDINGTelnetTask is waiting to be activated.
RUNNINGTelnetTask has received start prompt and is currently executing command.
TIMEDOUTTelnetTask exceeded maximum runtime timeout value.

Public Instance Constructors

TelnetTask Overloaded. Initializes a new instance of the TelnetTask class.

Public Instance Properties

CommandGets/Sets the TelnetTask command to execute.
EndPromptGets/Sets the shell end prompt this TelnetTask should wait for to indicate that this TelnetTask is complete.
EndPromptRegexGets/Sets if the end prompt is a regular expression
NameGets/Sets the name of this TelnetTask.
NextTaskGets/Sets the next task executed after this TelnetTask.
PreviousTaskGets/Sets the previous task executed before this TelnetTask.
ScriptGets/Sets the TelnetScript that this TelnetTask is bound to.
StartPromptGets/Sets the shell start prompt this TelnetTask should wait for before executing command.
StartPromptRegexGets/Sets if the start prompt is a regular expression.
StatusGets/Sets completion status of this TelnetTask.
TerminatorGets/Sets the command terminator used when sending commands to TELNET server. Default is "\n".
TimeoutGets/Sets the timeout in milliseconds for a running tasks to receive the expected end prompt. Default timeout is 120000ms (120 seconds).

Public Instance Methods

CancelCancels the current task and sets it's status to cancelled.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExecuteExecutes command as defined in TelnetTask constructor.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetResponseGets response to command executed.
GetType (inherited from Object)Gets the Type of the current instance.
IsActiveChecks if this TelnetTask is active.
IsCancelledChecks if this TelnetTask was cancelled.
IsCompleteChecks if this TelnetTask is complete due to sucessful completion, cancellation or exceeded timeout.
IsPendingChecks if this TelnetTask is pending activation.
IsRunningChecks if this TelnetTask is running.
IsTimedOutChecks if this TelnetTask exceeded task timeout.
OnTaskDataReceivedGets data received from TELNET server.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

TelnetTask Class | Jscape.Telnet Namespace