C-DEngine 5.105

TheISBConnect Members

The TheISBConnect type exposes the following members.

Constructors


  Name Description
Public method TheISBConnect
Creates a new ISB Connect Object

Methods


  Name Description
Public method CloneBase
Clonse an incoming object into this object
(Inherited from TheDataBase.)
Public method CloneTo
Clones the metadata of the current class to a new class provided to the method
(Inherited from TheMetaDataBase.)
Public method Connect(String, String)
Connect to a Custom URL via ISB Connect and a custom Scope
Public method Connect(String, String, Boolean)
Connect to a Custom URL via ISB Connect and a custom Scope
Public method Connect(String, String, String, Boolean)
Connect to a Custom URL via ISB Connect and a custom Scope
Public method Disconnect
Disposes the underlying QueuedSender. Don't use this if you have multiple ISBConnects to the same URL as they share the same QueuedSender
Public method EncryptedBuffer
Encrypts the ISBConnect Class Properties against the local node's ScopeID
Public method Equals(System.Object) (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FireEvent
Fire an Event on a property
(Inherited from TheDataBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method IsEventRegistered
Returns true if the requested eThingEvents has registered callbacks
(Inherited from TheDataBase.)
Protected method MemberwiseClone (Inherited from Object.)
Public method NotifyMirror
If called from a derived class and the class was stored in a StorageMirror, this method will call the "NotifyOfUpdate" method in the StorageMirror to inform all Notification Clients that this record has changed. This is VERY Expensive! Do not call too often! This does not work with StorageMirrors that require a PostSalt (unique table name)
(Inherited from TheDataBase.)
Protected method OnPropertyChanged (Inherited from TheBindableBase.)
Public method Reconnect
Reconnects this route with the same parameter set in "Connect"
Public method RegisterEvent
Register a callback that will be fired on a Property Event
(Inherited from TheDataBase.)
Public method RegisterEvent2
Register a callback that will be fired on a Property Event
(Inherited from TheDataBase.)
Public method SendToFirstNode
Sends a message to the first node in the mesh. Is is the Node this ISB Connection is connected to
Public method SendToNode
Sends a TSM to a specific node
Public method SendToOriginator
Sends back to the originator
Public method SendTSM(TSM)
Sends a TSM to via the ISB Connection. The ENG must contain the topic the message should be sent to
Public method SendTSM(TSM, String, Nullable<(Of <<'(Guid>)>>), Nullable<(Of <<'(Guid>)>>))
Sends a TSM with a custom topic with a possible target and Source Sender - in Par with ICDECommChannel
Public method SendTSM(String, TSM)
Sends a TSM via the ISB Connection to a custom Topic specified in the first parameter
Protected method SetProperty``1 (Inherited from TheBindableBase.)
Public method Subscribe
Subscribes to Custom topics on this ISB Connection. The Topics will be scoped with the scope used during connect
Public method ToString (Inherited from Object.)
Public method UnregisterEvent
Unregister a previously registered callback
(Inherited from TheDataBase.)
Public method UnregisterEvent2
Unregister a previously registered callback
(Inherited from TheDataBase.)
Public method Unsubscribe
Unsubscribes from Custom topics on this ISB Connection. The Topics will be scoped with the scope used during connect

Properties


  Name Description
Public property AT
Application Title
Public property cdeA
Access Level Mask 0=Everyone; 1=Untrusted Guest; 2=Trusted Guest; 4=Trusted Member1; 8=Trusted Member2; 16=Truested Member3; 32=Senior Member 1; 64=Senior Member 2; 128=Admin;
(Inherited from TheMetaDataBase.)
Public property cdeAVA
Availability of this record The higher this number the higher the availability of this record The Storage Service might store the data in multiple location to ensure maximum availability
(Inherited from TheDataBase.)
Public property cdeCTIM
Timestamp of this class. Will be set to DateTimeOffset.Now on creation of the Class
(Inherited from TheDataBase.)
Public property cdeEXP
Expiration in Seconds of the class If a derived class is stored in a StorageMirror and cdeEXP is set to>0, the StorageMirror will automatically delete this record after the time has passed
(Inherited from TheDataBase.)
Public property cdeF
Feature ID
(Inherited from TheMetaDataBase.)
Public property cdeM
The Cookie or Meta information for this class
(Inherited from TheMetaDataBase.)
Public property cdeMID
Unique Key for the class derived from TheDataBase. this will be used in the StorageService as the Unique Index in the SQL Tables
(Inherited from TheDataBase.)
Public property cdeN
Guid of Hosting Node - new in 4.108: Moved from MetaDataBase to here
(Inherited from TheDataBase.)
Public property cdeO
Owner Guid
(Inherited from TheMetaDataBase.)
Public property cdePRI
Priority of this record. A lower number means a higher priority. Data with higher priority will be retrieved faster than those with lower prio
(Inherited from TheDataBase.)
Public property cdeSEQ
Sequence number
(Inherited from TheMetaDataBase.)
Public property cdeU
User ID owning this resource
(Inherited from TheMetaDataBase.)
Public property CUS
Custom Message Content sent during Provisioning;
Public property ERR
Any Error message if applicable
Public property ES
Easy Scope: this is no longer supported and now a ScrambledScope ID
Public property FNI
First Node ID: DeviceID of the node providing this ISBConnect Block
Public property IS
Initial Subscriptions
Public property LCI
Language ID (LCID) for the connection
Public property MCS
NMI Main Configuration Screen (not implemented yet)
Public property NPA
NPA = Next Possible Address - contains the Crypted Session ID and in case of HTTP is the next URL Path
Public property PS
NMI Portal/Main Dashboard Screen
Public property PWD
Password (hash) currently not used
Public property QUI
Email or username
Public property SID
Scrambled Scope ID for the connection
Public property SSC
NMI Home Screen
Public property TLS
If true, TLS 1.2 is required
Public property UNA
Username - no longer used
Public property UPRE
User Preferences as JSON String
Public property VER
Version of the ISBConnect
Public property WSP
WebSockets port. Zero if no websockets supported

Events


  Name Description
Public event PropertyChanged
Multicast event for property change notifications.
(Inherited from TheBindableBase.)