C# Class IMB3.TConnection

Inheritance: TConnectionPlatform

Mostra file Open project: TNOCS/csTouch Class Usage Examples

Public Properties

Property	Type	Description
AutoPublish	bool
efPublishers	System.Int32
efSubscribers	System.Int32
efTimers	System.Int32
statusBusy	System.Int32
statusCalculating	System.Int32
statusReady	System.Int32

Public Methods

Method	Description
Close ( ) : void
ConvertEscapes ( byte aBuffer ) : string
ConvertToHex ( byte aBuffer ) : string
LogWriteLn ( string aLogEventName, string aLine, TEventEntry aLevel ) : int
Open ( string aHost, int aPort, bool aStartReadingThread = true ) : bool
Publish ( string aEventName, bool aUseFederationPrefix = true ) : TEventEntry
RemoveStatus ( ) : void
RequestAllVariablesFromImb ( ) : void
RequestEventname ( string aEventNameFilter, Int32 aEventFilters ) : int
SetState ( TConnectionState aState ) : void
SetThrottle ( Int32 aThrottle ) : void
SetVariableValue ( string aVarName, TByteBuffer aVarValue ) : void
SetVariableValue ( string aVarName, TByteBuffer aVarValue, TVarPrefix aVarPrefix ) : void
SetVariableValue ( string aVarName, string aVarValue ) : void
SetVariableValue ( string aVarName, string aVarValue, TVarPrefix aVarPrefix ) : void
SignalBuffer ( int aEventID, Int32 aBufferID, byte aBuffer, Int32 aEventFlags ) : int
SignalBuffer ( string aEventName, Int32 aBufferID, byte aBuffer, Int32 aEventFlags, bool aUseFederationPrefix = true ) : int
SignalChangeFederation ( Int32 aNewFederationID, string aNewFederation ) : int
SignalChangeObject ( int aEventID, Int32 aAction, Int32 aObjectID, string aAttribute = "" ) : int
SignalChangeObject ( string aEventName, Int32 aAction, Int32 aObjectID, string aAttribute = "", bool aUseFederationPrefix = true ) : int
SignalEvent ( int aEventID, TEventEntry aEventKind, TByteBuffer aEventPayload, bool aUseFederationPrefix = true ) : int
SignalEvent ( string aEventName, TEventEntry aEventKind, TByteBuffer aEventPayload, bool aUseFederationPrefix = true ) : int
SignalFocus ( double aX, double aY ) : int
SignalIntString ( string eventName, int cmd, string message ) : int
SignalStream ( int aEventID, string aStreamName, Stream aStream ) : int
SignalStream ( string aEventName, string aStreamName, Stream aStream, bool aUseFederationPrefix = true ) : int
SignalString ( string eventName, string message ) : int
Subscribe ( string aEventName, bool aUseFederationPrefix = true ) : TEventEntry
TConnection ( string aHost, int aPort, string aOwnerName, int aOwnerID, string aFederation = DefaultFederation, bool aIMB2Compatible = true, bool aStartReadingThread = true ) : System
UnPublish ( string aEventName, bool aUseFederationPrefix = true ) : void
UnSubscribe ( string aEventName, bool aUseFederationPrefix = true ) : void
UpdateStatus ( Int32 aProgress, Int32 aStatus ) : void

Protected Methods

Method	Description
HandleCommand ( TCommands aCommand, TByteBuffer aPayload ) : void

Private Methods

Method	Description
AddEvent ( string aEventName ) : TEventEntry
AddEventL ( string aEventName ) : TEventEntry
EventIDToEventL ( Int32 aEventID ) : TEventEntry
FindEventAutoPublishL ( string aEventName ) : TEventEntry
FindEventL ( string aEventName ) : TEventEntry
FindEventParentL ( string aEventName ) : TEventEntry
FindOrAddEventL ( string aEventName ) : TEventEntry
GetUniqueClientID ( ) : int
HandleCommandEvent ( TByteBuffer aPayload ) : void
HandleCommandOther ( TCommands aCommand, TByteBuffer aPayload ) : void
HandleCommandVariable ( TByteBuffer aPayload ) : void
HandleEventNames ( TByteBuffer aPayload ) : void
HandleSubAndPub ( TCommands aCommand, TByteBuffer aPayload ) : void
PrefixFederation ( string aName, bool aUseFederationPrefix = true ) : string
RequestUniqueClientID ( ) : int
SetOwner ( ) : int
WriteCommand ( TCommands aCommand, byte aPayload ) : int

Method Details

Close() public method

public Close ( ) : void
return	void

ConvertEscapes() public static method

public static ConvertEscapes ( byte aBuffer ) : string
aBuffer	byte
return	string

ConvertToHex() public static method

public static ConvertToHex ( byte aBuffer ) : string
aBuffer	byte
return	string

HandleCommand() protected method

protected HandleCommand ( TCommands aCommand, TByteBuffer aPayload ) : void
aCommand	TCommands
aPayload	IMB3.ByteBuffers.TByteBuffer
return	void

LogWriteLn() public method

public LogWriteLn ( string aLogEventName, string aLine, TEventEntry aLevel ) : int
aLogEventName	string
aLine	string
aLevel	TEventEntry
return	int

Open() public method

public Open ( string aHost, int aPort, bool aStartReadingThread = true ) : bool
aHost	string
aPort	int
aStartReadingThread	bool
return	bool

Publish() public method

public Publish ( string aEventName, bool aUseFederationPrefix = true ) : TEventEntry
aEventName	string
aUseFederationPrefix	bool
return	TEventEntry

RemoveStatus() public method

public RemoveStatus ( ) : void
return	void

RequestAllVariablesFromImb() public method

public RequestAllVariablesFromImb ( ) : void
return	void

RequestEventname() public method

public RequestEventname ( string aEventNameFilter, Int32 aEventFilters ) : int
aEventNameFilter	string
aEventFilters	System.Int32
return	int

SetState() public method

public SetState ( TConnectionState aState ) : void
aState	TConnectionState
return	void

SetThrottle() public method

public SetThrottle ( Int32 aThrottle ) : void
aThrottle	System.Int32
return	void

SetVariableValue() public method

public SetVariableValue ( string aVarName, TByteBuffer aVarValue ) : void
aVarName	string
aVarValue	IMB3.ByteBuffers.TByteBuffer
return	void

SetVariableValue() public method

public SetVariableValue ( string aVarName, TByteBuffer aVarValue, TVarPrefix aVarPrefix ) : void
aVarName	string
aVarValue	IMB3.ByteBuffers.TByteBuffer
aVarPrefix	TVarPrefix
return	void

SetVariableValue() public method

public SetVariableValue ( string aVarName, string aVarValue ) : void
aVarName	string
aVarValue	string
return	void

SetVariableValue() public method

public SetVariableValue ( string aVarName, string aVarValue, TVarPrefix aVarPrefix ) : void
aVarName	string
aVarValue	string
aVarPrefix	TVarPrefix
return	void

SignalBuffer() public method

public SignalBuffer ( int aEventID, Int32 aBufferID, byte aBuffer, Int32 aEventFlags ) : int
aEventID	int
aBufferID	System.Int32
aBuffer	byte
aEventFlags	System.Int32
return	int

SignalBuffer() public method

public SignalBuffer ( string aEventName, Int32 aBufferID, byte aBuffer, Int32 aEventFlags, bool aUseFederationPrefix = true ) : int
aEventName	string
aBufferID	System.Int32
aBuffer	byte
aEventFlags	System.Int32
aUseFederationPrefix	bool
return	int

SignalChangeFederation() public method

public SignalChangeFederation ( Int32 aNewFederationID, string aNewFederation ) : int
aNewFederationID	System.Int32
aNewFederation	string
return	int

SignalChangeObject() public method

public SignalChangeObject ( int aEventID, Int32 aAction, Int32 aObjectID, string aAttribute = "" ) : int
aEventID	int
aAction	System.Int32
aObjectID	System.Int32
aAttribute	string
return	int

SignalChangeObject() public method

public SignalChangeObject ( string aEventName, Int32 aAction, Int32 aObjectID, string aAttribute = "", bool aUseFederationPrefix = true ) : int
aEventName	string
aAction	System.Int32
aObjectID	System.Int32
aAttribute	string
aUseFederationPrefix	bool
return	int

SignalEvent() public method

public SignalEvent ( int aEventID, TEventEntry aEventKind, TByteBuffer aEventPayload, bool aUseFederationPrefix = true ) : int
aEventID	int
aEventKind	TEventEntry
aEventPayload	IMB3.ByteBuffers.TByteBuffer
aUseFederationPrefix	bool
return	int

SignalEvent() public method

public SignalEvent ( string aEventName, TEventEntry aEventKind, TByteBuffer aEventPayload, bool aUseFederationPrefix = true ) : int
aEventName	string
aEventKind	TEventEntry
aEventPayload	IMB3.ByteBuffers.TByteBuffer
aUseFederationPrefix	bool
return	int

SignalFocus() public method

public SignalFocus ( double aX, double aY ) : int
aX	double
aY	double
return	int

SignalIntString() public method

public SignalIntString ( string eventName, int cmd, string message ) : int
eventName	string
cmd	int
message	string
return	int

SignalStream() public method

public SignalStream ( int aEventID, string aStreamName, Stream aStream ) : int
aEventID	int
aStreamName	string
aStream	Stream
return	int

SignalStream() public method

public SignalStream ( string aEventName, string aStreamName, Stream aStream, bool aUseFederationPrefix = true ) : int
aEventName	string
aStreamName	string
aStream	Stream
aUseFederationPrefix	bool
return	int

SignalString() public method

public SignalString ( string eventName, string message ) : int
eventName	string
message	string
return	int

Subscribe() public method

public Subscribe ( string aEventName, bool aUseFederationPrefix = true ) : TEventEntry
aEventName	string
aUseFederationPrefix	bool
return	TEventEntry

TConnection() public method

public TConnection ( string aHost, int aPort, string aOwnerName, int aOwnerID, string aFederation = DefaultFederation, bool aIMB2Compatible = true, bool aStartReadingThread = true ) : System
aHost	string
aPort	int
aOwnerName	string
aOwnerID	int
aFederation	string
aIMB2Compatible	bool
aStartReadingThread	bool
return	System

UnPublish() public method

public UnPublish ( string aEventName, bool aUseFederationPrefix = true ) : void
aEventName	string
aUseFederationPrefix	bool
return	void

UnSubscribe() public method

public UnSubscribe ( string aEventName, bool aUseFederationPrefix = true ) : void
aEventName	string
aUseFederationPrefix	bool
return	void

UpdateStatus() public method

public UpdateStatus ( Int32 aProgress, Int32 aStatus ) : void
aProgress	System.Int32
aStatus	System.Int32
return	void

Property Details

AutoPublish public_oe property

public bool AutoPublish
return	bool

efPublishers public_oe property

public Int32,System efPublishers
return	System.Int32

efSubscribers public_oe property

public Int32,System efSubscribers
return	System.Int32

efTimers public_oe property

public Int32,System efTimers
return	System.Int32

statusBusy public_oe static_oe property

public static Int32,System statusBusy
return	System.Int32

statusCalculating public_oe static_oe property

public static Int32,System statusCalculating
return	System.Int32

statusReady public_oe static_oe property

public static Int32,System statusReady
return	System.Int32