Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in Reactor. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
Class | Package | Description | |
---|---|---|---|
AccountEvent | net.user1.reactor | AccountEvent is a simple data class used to pass information from a UserAccount object or AccountManager object to registered event-listeners when an account event occurs. | |
AccountListSnapshot | net.user1.reactor.snapshot | The AccountListSnapshot class is used to load a list of userIDs for all user accounts on the server. | |
AccountManager | net.user1.reactor | The AccountManager class provides control over Union user accounts. | |
AccountManagerEvent | net.user1.reactor | AccountManagerEvent is a simple data class used to pass information from the AccountManager to registered event-listeners when an account management event occurs. | |
AccountSnapshot | net.user1.reactor.snapshot | The AccountSnapshot class is used to load a "snapshot" of a server-side user account. | |
AndGroup | net.user1.reactor.filters | Defines a Boolean AND relationship between multiple comparisons in a message filter. | |
ArrayUtil | net.user1.utils | Utilities for working with Arrays. | |
Attribute | net.user1.reactor | A simple data class representing an attribute of a client, a room, or a user account. | |
AttributeCollection | net.user1.reactor | An collection of attributes for a client, user account, or room. | |
AttributeComparison | net.user1.reactor.filters | Represents a single attribute comparison to be used in a filter. | |
AttributeEvent | net.user1.reactor | AttributeEvent is a simple data class used to pass information from an object to registered event-listeners when an attribute event occurs. | |
AttributeFilter | net.user1.reactor.filters | Defines an attribute filter to be applied to a client-to-server message. | |
BannedListSnapshot | net.user1.reactor.snapshot | The BannedListSnapshot class is used to load the server's current list of banned client addresses. | |
BooleanGroup | net.user1.reactor.filters | The base class for AndGroup and OrGroup, which define Boolean relationships between multiple comparisons in filters. | |
BooleanGroupType | net.user1.reactor.filters | An enumeration of the types of Boolean groups in the Reactor filtering API. | |
CacheNode | net.user1.utils | A node in the LRUCache. | |
Client | net.user1.reactor | The Client class represents a unique client that is connected to Union Server. | |
ClientCountSnapshot | net.user1.reactor.snapshot | The ClientCountSnapshot class is used to retrieve the number of clients currently on the server. | |
ClientEvent | net.user1.reactor | ClientEvent is a simple data class used to pass information from a Client object to registered event-listeners when a client event occurs. | |
ClientListSnapshot | net.user1.reactor.snapshot | The ClientListSnapshot class is used to load a list of clientIDs for the clients currently on the server. | |
ClientManager | net.user1.reactor | The ClientManager class provides centralized access to Client instances, which represent clients connected to Union Server. | |
ClientManagerEvent | net.user1.reactor | ClientManagerEvent is a simple data class used to pass information from an application's ClientManager to registered event-listeners when a client-management event occurs. | |
ClientManifest | net.user1.reactor | A ClientManifest is a data object containing information about a client on the server, including attributes, a list of the rooms the client is in, and a list of rooms the client is observing. | |
ClientSnapshot | net.user1.reactor.snapshot | The ClientSnapshot class is used to load a "snapshot" of a client on the server. | |
CompareType | net.user1.reactor.filters | An enumeration of the types of comparisons in the Reactor filtering API. | |
Connection | net.user1.reactor | The Connection is the base class of all Reactor connection classes, including XMLSocketConnection and HTTPConnection. | |
ConnectionEvent | net.user1.reactor | ConnectionEvent is a simple data class used to pass information about a connection event to registered event-listeners. | |
ConnectionManager | net.user1.reactor | The ConnectionManager class manages all connections made by a Reactor appliction to Union Server. | |
ConnectionManagerEvent | net.user1.reactor | ConnectionManagerEvent is a simple data class used to pass information about a connection-manager event to registered event-listeners. | |
ConnectionMonitor | net.user1.reactor | The ConnectionMonitor class provides an application heartbeat and automatic disconnection and reconnection services. | |
ConnectionRefusal | net.user1.reactor | A simple data class describing a connection refusal by Union Server. | |
ConnectionRefusalReason | net.user1.reactor | The ConnectionRefusalReason class is an enumeration of constant values representing the known reasons Union Server will refuse a client connection. | |
ConnectionState | net.user1.reactor | The ClientConnectionState class is an enumeration of constant values representing the state of a client's current connection to the server. | |
ConnectionType | net.user1.reactor | An enumeration of the types of connections Reactor applications can use to connect to Union server. | |
CustomClient | net.user1.reactor | A base class for the creation of custom client classes. | |
EventUtil | net.user1.utils | Utilities for working with Events. | |
Filter | net.user1.reactor.filters | Defines a filter to be applied to a client-to-server message. | |
FilterSet | net.user1.reactor.filters | Defines a set of individuals filters to be combined into a composite filter for use in a client-to-server message. | |
Gateway | net.user1.reactor | A simple data class providing information about a gateway deployed on Union Server. | |
GatewayBandwidth | net.user1.reactor | A simple data class providing information about bandwidth usage and throughput for a gateway deployed on Union Server. | |
GatewaysSnapshot | net.user1.reactor.snapshot | The GatewaysSnapshot class is used to retrieve a per-gateway summary of connection and bandwidth statistics. | |
HTTPConnection | net.user1.reactor | The HTTPConnection class is used by Reactor to communicate with Union Server over HTTP. | |
IClient | net.user1.reactor | The interface implemented by all classes that wish to represent a client in the Reactor API. | |
IComparable | net.user1.reactor.filters | The IComparable interface defines the methods that must be implemented by all classes that represent comparisons in the Reactor filtering API. | |
IConnection | net.user1.reactor | IConnection is the interface that all connection classes must implement in order to connect to Union. | |
IFilter | net.user1.reactor.filters | The IFilter interface defines the methods that must be implemented by Reactor's filter classes; filter classes are used to specify a logical group of clients, typically for the sake of targeted messaging. | |
LocalData | net.user1.utils | The LocalData class stores typed ActionScript data locally on the end-user's hard drive. | |
LogEvent | net.user1.logger | LogEvent is a simple data class used to pass information from an application's Logger to registered event-listeners when a log event occurs. | |
Logger | net.user1.logger | The Logger class manages Reactor's client-side log, which records client/server communications and events of general interest for the purposes of debugging. | |
LogTracer | net.user1.logger | Displays log messages in the Output window (Flash authoring) or Console (Flex Builder, Flash Builder). | |
LRUCache | net.user1.utils | A least-recently-used object cache. | |
MemoryStore | net.user1.utils | A minimal in-memory storage map with an API that matches LocalData's persistent-map API. | |
MessageManager | net.user1.reactor | The MessageManager class provides a set of services related to sending and receiving messages between the client and server. | |
Messages | net.user1.reactor | The Messages class defines constants representing the built-in messages defined by the Reactor library. | |
ModuleDefinition | net.user1.reactor | A simple data class representing the definition of a server-side module. | |
ModuleType | net.user1.reactor | The ModuleType class is an enumeration of constant values representing different module types for a server-side module. | |
NodeListSnapshot | net.user1.reactor.snapshot | The NodeListSnapshot class is used to load a list of the Union Server nodes connected to the current server. | |
NumericFormatter | net.user1.utils | A utility class for converting numeric data to human-readable Strings. | |
ObjectUtil | net.user1.utils | Utilities for working with Objects. | |
OrGroup | net.user1.reactor.filters | Defines a Boolean OR relationship between multiple comparisons in a message filter. | |
Reactor | net.user1.reactor | The Reactor class is the root class of every Reactor client application. | |
ReactorEvent | net.user1.reactor | ReactorEvent is a simple data class used to pass information from an application's Reactor object to registered event-listeners when a Reactor event occurs. | |
Room | net.user1.reactor | The Room class represents a Union room, which is a place for clients to engage in group communication. | |
RoomClassRegistry | net.user1.reactor | RoomClassRegistry maintains a catalog of the classes that are used to represent the rooms in an application. | |
RoomEvent | net.user1.reactor | RoomEvent is a simple data class used to pass information from a Room object to registered event-listeners when a room event occurs. | |
RoomIDParser | net.user1.reactor | Provides convenience methods for retreiving the qualifier and simple id of a string fully qualified room id. | |
RoomListSnapshot | net.user1.reactor.snapshot | The RoomListSnapshot class is used to load a list of fully qualified roomIDs for all rooms on the server or all rooms with a given qualifier. | |
RoomManager | net.user1.reactor | The RoomManager class provides access to Room objects, and utilities for creating, destroying, joining, and observing rooms on the server. | |
RoomManagerEvent | net.user1.reactor | RoomManagerEvent is a simple data class used to pass information from an application's RoomManager to registered event-listeners when a room-management event occurs. | |
RoomModules | net.user1.reactor | A simple data container indicating the locations and names of a set of server-side room modules. | |
RoomSettings | net.user1.reactor | A simple data container describing the configuration settings for a room. | |
RoomSnapshot | net.user1.reactor.snapshot | The RoomSnapshot class is used to load a "snapshot" of a room on the server. | |
SecureHTTPConnection | net.user1.reactor | The SecureHTTPConnection class is identical to HTTPConnection except that it performs communications over HTTPS (i.e., an encrypted TLS or SSL connection) rather than plain HTTP. | |
SecureSocketConnection | net.user1.reactor | The SecureSocketConnection class is used by Reactor to communicate with Union Server over a TLS-encrypted, persistent TCP/IP socket. | |
SecurityRole | net.user1.reactor | The SecurityRole class is an enumeration of constant values representing different security roles for a user account. | |
Server | net.user1.reactor | Provides access to global server data and functions, and a means of communicating with server modules. | |
ServerEvent | net.user1.reactor | ServerEvent is a simple data class used to pass information from an application's Server object to registered event-listeners when a server event occurs. | |
ServerModuleListSnapshot | net.user1.reactor.snapshot | The ServerModuleListSnapshot class is used to load the server's current list of active server modules (not to be confused with room modules). | |
Snapshot | net.user1.reactor.snapshot | Reactor’s "snapshots" provide a traditional request/response mechanism for retrieving data on demand from Union Server; the Snapshot class is the abstract base class for all Reactor "snapshot" classes, each of which loads a specific set of data from the server. | |
SnapshotEvent | net.user1.reactor.snapshot | SnapshotEvent is a simple data class used to pass information from Snapshot objects to registered event-listeners when a snapshot event occurs. | |
Statistics | net.user1.reactor | Provides a variety of networking and performance statistics for a Reactor object. | |
Status | net.user1.reactor | An enumeration of the status codes for all built-in UPC messages and Reactor events. | |
SynchronizationState | net.user1.reactor | The SynchronizationState class is an enumeration of constant values describing the current synchronization state of a client-side object such as a room. | |
System | net.user1.reactor | Version information for the Reactor client SDK. | |
Tokens | net.user1.reactor | A collection of constants representing meaningful tokens in communications with Union Server. | |
UDictionary | net.user1.utils | A simple wrapper around the ActionScript Dictionary class, with the added ability to return the number of items in the dictionary. | |
UPC | net.user1.reactor | Represents a UPC-formatted message, and also enumerates the internal message ids for UPC messages used by Reactor. | |
UPCProcessingRecord | net.user1.reactor | A data container describing server-side processing-statistics for a single UPC message received and then processed by Union Server. | |
UPCStatsSnapshot | net.user1.reactor.snapshot | The UPCStatsSnapshot class is used to retrieve statistics about the UPC messages that have been processed or are waiting to be processed by Union Server. | |
UpdateLevels | net.user1.reactor | The UpdateLevels class specifies the amount of information a client wishes to receive from the server about a room it has either joined or is observing. | |
UserAccount | net.user1.reactor | The UserAccount class represents a Union user account. | |
Validator | net.user1.reactor | Provides a collection of validation methods used to check whether a roomID or attribute name is legally formed. | |
VersionNumber | net.user1.reactor | ||
XMLSocketConnection | net.user1.reactor | The XMLSocketConnection class is used by Reactor to communicate with Union Server over a persistent TCP/IP socket. |