C# Класс IMB3.TConnection

Наследование: TConnectionPlatform
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
AutoPublish bool
efPublishers System.Int32
efSubscribers System.Int32
efTimers System.Int32
statusBusy System.Int32
statusCalculating System.Int32
statusReady System.Int32

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
HandleCommand ( TCommands aCommand, TByteBuffer aPayload ) : void

Приватные методы

Метод Описание
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

Описание методов

Close() публичный Метод

public Close ( ) : void
Результат void

ConvertEscapes() публичный статический Метод

public static ConvertEscapes ( byte aBuffer ) : string
aBuffer byte
Результат string

ConvertToHex() публичный статический Метод

public static ConvertToHex ( byte aBuffer ) : string
aBuffer byte
Результат string

HandleCommand() защищенный Метод

protected HandleCommand ( TCommands aCommand, TByteBuffer aPayload ) : void
aCommand TCommands
aPayload IMB3.ByteBuffers.TByteBuffer
Результат void

LogWriteLn() публичный Метод

public LogWriteLn ( string aLogEventName, string aLine, TEventEntry aLevel ) : int
aLogEventName string
aLine string
aLevel TEventEntry
Результат int

Open() публичный Метод

public Open ( string aHost, int aPort, bool aStartReadingThread = true ) : bool
aHost string
aPort int
aStartReadingThread bool
Результат bool

Publish() публичный Метод

public Publish ( string aEventName, bool aUseFederationPrefix = true ) : TEventEntry
aEventName string
aUseFederationPrefix bool
Результат TEventEntry

RemoveStatus() публичный Метод

public RemoveStatus ( ) : void
Результат void

RequestAllVariablesFromImb() публичный Метод

public RequestAllVariablesFromImb ( ) : void
Результат void

RequestEventname() публичный Метод

public RequestEventname ( string aEventNameFilter, Int32 aEventFilters ) : int
aEventNameFilter string
aEventFilters System.Int32
Результат int

SetState() публичный Метод

public SetState ( TConnectionState aState ) : void
aState TConnectionState
Результат void

SetThrottle() публичный Метод

public SetThrottle ( Int32 aThrottle ) : void
aThrottle System.Int32
Результат void

SetVariableValue() публичный Метод

public SetVariableValue ( string aVarName, TByteBuffer aVarValue ) : void
aVarName string
aVarValue IMB3.ByteBuffers.TByteBuffer
Результат void

SetVariableValue() публичный Метод

public SetVariableValue ( string aVarName, TByteBuffer aVarValue, TVarPrefix aVarPrefix ) : void
aVarName string
aVarValue IMB3.ByteBuffers.TByteBuffer
aVarPrefix TVarPrefix
Результат void

SetVariableValue() публичный Метод

public SetVariableValue ( string aVarName, string aVarValue ) : void
aVarName string
aVarValue string
Результат void

SetVariableValue() публичный Метод

public SetVariableValue ( string aVarName, string aVarValue, TVarPrefix aVarPrefix ) : void
aVarName string
aVarValue string
aVarPrefix TVarPrefix
Результат void

SignalBuffer() публичный Метод

public SignalBuffer ( int aEventID, Int32 aBufferID, byte aBuffer, Int32 aEventFlags ) : int
aEventID int
aBufferID System.Int32
aBuffer byte
aEventFlags System.Int32
Результат int

SignalBuffer() публичный Метод

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
Результат int

SignalChangeFederation() публичный Метод

public SignalChangeFederation ( Int32 aNewFederationID, string aNewFederation ) : int
aNewFederationID System.Int32
aNewFederation string
Результат int

SignalChangeObject() публичный Метод

public SignalChangeObject ( int aEventID, Int32 aAction, Int32 aObjectID, string aAttribute = "" ) : int
aEventID int
aAction System.Int32
aObjectID System.Int32
aAttribute string
Результат int

SignalChangeObject() публичный Метод

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
Результат int

SignalEvent() публичный Метод

public SignalEvent ( int aEventID, TEventEntry aEventKind, TByteBuffer aEventPayload, bool aUseFederationPrefix = true ) : int
aEventID int
aEventKind TEventEntry
aEventPayload IMB3.ByteBuffers.TByteBuffer
aUseFederationPrefix bool
Результат int

SignalEvent() публичный Метод

public SignalEvent ( string aEventName, TEventEntry aEventKind, TByteBuffer aEventPayload, bool aUseFederationPrefix = true ) : int
aEventName string
aEventKind TEventEntry
aEventPayload IMB3.ByteBuffers.TByteBuffer
aUseFederationPrefix bool
Результат int

SignalFocus() публичный Метод

public SignalFocus ( double aX, double aY ) : int
aX double
aY double
Результат int

SignalIntString() публичный Метод

public SignalIntString ( string eventName, int cmd, string message ) : int
eventName string
cmd int
message string
Результат int

SignalStream() публичный Метод

public SignalStream ( int aEventID, string aStreamName, Stream aStream ) : int
aEventID int
aStreamName string
aStream Stream
Результат int

SignalStream() публичный Метод

public SignalStream ( string aEventName, string aStreamName, Stream aStream, bool aUseFederationPrefix = true ) : int
aEventName string
aStreamName string
aStream Stream
aUseFederationPrefix bool
Результат int

SignalString() публичный Метод

public SignalString ( string eventName, string message ) : int
eventName string
message string
Результат int

Subscribe() публичный Метод

public Subscribe ( string aEventName, bool aUseFederationPrefix = true ) : TEventEntry
aEventName string
aUseFederationPrefix bool
Результат TEventEntry

TConnection() публичный Метод

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
Результат System

UnPublish() публичный Метод

public UnPublish ( string aEventName, bool aUseFederationPrefix = true ) : void
aEventName string
aUseFederationPrefix bool
Результат void

UnSubscribe() публичный Метод

public UnSubscribe ( string aEventName, bool aUseFederationPrefix = true ) : void
aEventName string
aUseFederationPrefix bool
Результат void

UpdateStatus() публичный Метод

public UpdateStatus ( Int32 aProgress, Int32 aStatus ) : void
aProgress System.Int32
aStatus System.Int32
Результат void

Описание свойств

AutoPublish публичное свойство

public bool AutoPublish
Результат bool

efPublishers публичное свойство

public Int32,System efPublishers
Результат System.Int32

efSubscribers публичное свойство

public Int32,System efSubscribers
Результат System.Int32

efTimers публичное свойство

public Int32,System efTimers
Результат System.Int32

statusBusy публичное статическое свойство

public static Int32,System statusBusy
Результат System.Int32

statusCalculating публичное статическое свойство

public static Int32,System statusCalculating
Результат System.Int32

statusReady публичное статическое свойство

public static Int32,System statusReady
Результат System.Int32