OASySDNA.Common.PubSub Namespace
- Last UpdatedApr 08, 2026
- 8 minute read
| Class | Description | |
|---|---|---|
 | BlockingPubSubSubscription | This class represents a synchronous PubSub topic subscription. |
| GlobalPubSubConnectionAccessor | This class provides access to the underlying global PubSub connection instance. |
| PackedRTPublication | This class unpacks RealTime database (RTDB) fields from a PubSub buffer. |
| PubSubBuffer | This class creates and manages a PubSub buffer. |
| PubSubBuffer.EmptyException | The empty exceptions are thrown when an attempt is made to read from an empty PubSubBuffer. |
| PubSubBuffer.FullException | The full exceptions are thrown when an attempt is made to write into a full PubSubBuffer. |
| PubSubBuffer.NotOwnedException | The not owned exceptions are thrown when a request was made to resize a character array that is not owned by the PubSubBuffer handling the request. |
| PubSubBuffer.PubSubBufferException | The base exception class that all the PubSubBuffer exceptions inherit from. Catching an exception of this type will catch all of the exceptions relating to the PubSubBuffer. |
| PubSubBuffer.ReadFailedException | The read failed exceptions are thrown when a read fails to a PubSubBuffer for an unknown reason. |
| PubSubBuffer.UnsupportedTypeException | The unsupported type exceptions are thrown when a request was made to write a type that is not supported by the PubSubBuffer. |
| PubSubBuffer.WriteFailedException | The write failed exceptions are thrown when a write to a PubSubBuffer fails for an unknown reason. |
| PubSubBuffer.WrongReadTypeException | The wrong read exceptions are thrown when a request was made to read a type that does not match the one stored in the PubSubBuffer at the current location. |
| PubSubConnection | A PubSub connection enables an application to publish information associated with a topic string and to subscribe to topic strings, thereby receiving published information on those topics. Other publish-related and subscribe-related functionality, such as security restrictions, are also supported by the PubSub connection. |
| PubSubConnection.BadCallException | Bad call exceptions are thrown when a callback subscribe was initiated when previous subscriptions were blocking or a blocking subscribe was initiated when previous subscriptions were callback. |
| PubSubConnection.BadTopicException | Bad topic exceptions are thrown when an application tries to perform an operation using a topic that does not conform to the topic grammar. All topics must conform as follows:
|
| PubSubConnection.BadTypeException | Bad type exceptions are thrown when a bad value is passed in for an enumeration. |
| PubSubConnection.DataOverflowException | Data overflow exceptions are thrown when an application tries to publish data that is longer than the maximum data length allowed. These exceptions are also thrown if a data buffer is provided to the receive function that is too small to handle the incoming data. |
| PubSubConnection.EngineException | Engine exceptions are thrown when an application loses its PubSub connection because the application was too slow to process incoming messages, the connection broke, or the engine died. |
| PubSubConnection.NoMemException | No memory exceptions are thrown when the internal PubSub Application Programming Interface (API) has trouble allocating memory. This exception is a critical failure. |
| PubSubConnection.NoPubException | No publisher exceptions are thrown when a No Publisher notification arrives on a topic. The internal fields of the exception contain all of the needed information. |
| PubSubConnection.NotInitException | Not initialized exceptions are thrown when an operation is attempted against a PubSub object that is not connected to PubSub. Ensure that the object is connected using IsConnected(), or trap this error and reconnect. |
| PubSubConnection.PermissionException | Permission exceptions are thrown when a publish call is initiated against a restricted topic. All topics beginning with "pubsub" are restricted, and applications can request topic restriction through the SecureTopic Application Programming Interface (API) call. In the latter case, most likely the application is trying to publish to a system-critical field that should not be accessible given the application's user context. |
| PubSubConnection.PubSubConnectionException | The base exception class for PubSubConnection exceptions. This class describes the basic information that PubSubConnection exceptions contain and is the base that all PubSubConnection exceptions inherit from. The class itself can be instantiated if needed, and it results in an exception with PubSubStatus.PS_OK as its internal status value. Such an exception should never be thrown. |
| PubSubConnection.TimeoutException | Bad timeout exceptions are thrown when an operation called with a timeout has timed out. |
| PubSubConnection.TopicOverflowException | Topic overflow exceptions are thrown when an application tries to subscribe to or publish on a topic that is longer than the maximum topic length allowed. These exceptions are also thrown if a topic buffer is provided to the receive function that is too small to handle the incoming topic string. |
| PubSubConnectionExtensions | A class that contains PubSubConnection extension methods. |
| PubSubConnectionFactory | A factory class to create new IPubSubConnection instances. |
| PubSubException | This is the base exception class for PubSub exceptions. It describes the basic information that PubSub exceptions contain and is the base that all PubSub exceptions inherit from. The class itself can be instantiated if needed, and it results in an exception with PubSubStatus.PS_OK as its internal status value. Such an exception should never be thrown. |
| PubSubMessage | This class represents a PubSub message to send over a PubSub connection or receive from a PubSub subscription. |
| PubSubMessageBuilder | This class constructs the PubSubMessage. |
| Interface | Description | |
|---|---|---|
 | IGlobalPubSubConnectionAccessor | The interface definition for accessing the underlying global PubSub connection instance. |
| IPubSubBuffer | The interface definition for a PubSubBuffer. |
| IPubSubConnection | A PubSub connection enables an application to publish information associated with a topic string and to subscribe to topic strings, thereby receiving published information on those topics. Other publish-related and subscribe-related functionality, such as security restrictions, are also supported by the PubSub connection. |
| IPubSubConnectionFactory | The interface definition for creating a new IPubSubConnection instance. |
| IPubSubSubscription | The interface definition for a PubSub topic subscription. |
| IReadOnlyPubSubBuffer | The Interface definition for a read-only PubSubBuffer. |
| ISharedPubSubConnection | A PubSub connection enables an application to publish information associated with a topic string and to subscribe to topic strings, thereby receiving published information on those topics. Other publish-related and subscribe-related functionality, such as security restrictions, are also supported by the PubSub connection. |
| Delegate | Description | |
|---|---|---|
 | PubSubCallbackMethod | The delegate used for callbacks from PubSub. |
| Enumeration | Description | |
|---|---|---|
 | PubSubBuffer.PSDataType | An enumeration of values to match those presented by the raw "C" Application Programming Interface (API). These values describe the type of data stored in a PubSubBuffer. |
| PubSubDataType | An enumeration of values matching those presented by the raw "C" Application Programming Interface (API). These values describe the type of data stored in a PubSubBuffer or PubSubMessage. |
| PubSubHeaderData | An enumeration of special routing information. |
| PubSubSecurityFlag | This enumeration is used with the |
| PubSubStatus | An enumeration of state codes that are used to convey information from the PubSub system to the application. |
| PubSubUpdateFlag | This enumeration is used with the PSsubscribe and PSsubscribeCB functions to indicate if an initial integrity update is requested or not. |