air.net

# SocketMonitor - AS3

Package | air.net
Class | public class SocketMonitor
Inheritance | SocketMonitor ServiceMonitor EventDispatcher Object
Subclasses | SecureSocketMonitor

Runtime Versions: | AIR 1.0

A SocketMonitor object monitors availablity of a TCP endpoint.

This class is included in the aircore.swc file. Flash Builder loads this class automatically when you create a project for AIR. The Flex SDK also includes this aircore.swc file, which you should include when compiling the application if you are using Flex SDK.

In Adobe® Flash® Professional CS3, this class is included in the ServiceMonitorShim.swc file. To use classes in the air.net package , you must first drag the ServiceMonitorShim component from the Components panel to the Library and then add the following `import` statement to your ActionScript 3.0 code:

    import air.net.*;

Copy

To use air.net package in Adobe® Flash® Professional (CS4 or higher):

1. Select the File > Publish Settings command.
2. In the Flash panel, click the Settings button for ActionScript 3.0. Select Library Path.
3. Click the Browse to SWC File button. Browse to Adobe Flash CSn/AIKn.n/frameworks/libs/air/aircore.swc file in the Adobe Flash Professional installation folder.
4. Click the OK button.
5. Add the following `import` statement to your ActionScript 3.0 code: `import air.net.*;`

More examples

Socket monitoring

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | available : Boolean Whether the service is currently considered "available." The initial value is false until either a status check sets the property to true or the property is initialized to true explicitly. Typically, this property is set by the checkStatus() implementation in a subclass or specializer, but if the application has independent information about a service's availability (for example, a request just succeeded or failed), the property can be set explicitly. | ServiceMonitor
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | host : String [read-only] The host being monitored. | SocketMonitor
|  | lastStatusUpdate : Date [read-only] The time of the last status update. | ServiceMonitor
|  | pollInterval : Number The interval, in milliseconds, for polling the server. | ServiceMonitor
|  | port : int [read-only] The port being monitored. | SocketMonitor
|  | running : Boolean [read-only] Whether the monitor has been started. | ServiceMonitor

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SocketMonitor(host:String, port:int) Creates a SocketMonitor object for a specified TCP endpoint. | SocketMonitor
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | makeJavascriptSubclass(constructorFunction:Object):void [static] Adds public ServiceMonitor methods to a JavaScript constructor function's prototype. | ServiceMonitor
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | start():void Starts the service monitor. | ServiceMonitor
|  | stop():void Stops monitoring the service. | ServiceMonitor
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns the string representation of the specified object. | SocketMonitor
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods

| Method | Defined By
--- | --- | ---
|  | checkStatus():void [override] Calling the checkStatus() method of a SocketMonitor object causes the application to try connecting to the socket, to check for a connect event. | SocketMonitor
|  | createSocket():Socket Creates a Socket object. | SocketMonitor

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | status | Indicates that the service status has changed. | ServiceMonitor

Property Detail

### host

property

`host:String` [read-only]

Runtime Versions: | AIR 1.0

The host being monitored.

Implementation
`public function get host():String`

### port

property

`port:int` [read-only]

Runtime Versions: | AIR 1.0

The port being monitored.

Implementation
`public function get port():int`
Constructor Detail

### SocketMonitor

()
Constructor

`public function SocketMonitor(host:String, port:int)`

Runtime Versions: | AIR 1.0

Creates a SocketMonitor object for a specified TCP endpoint.

After creating a SocketMonitor object, the caller should call `start` to begin monitoring the status of the service.

As with the Timer object, the caller should maintain a reference to the SocketMonitor object. Otherwise, the runtime deletes the object and monitoring ends.

Parameters

| `host:String` — The host to monitor.
| `port:int` — The port to monitor.

Method Detail

### checkStatus

()
method

`override protected function checkStatus():void`

Runtime Versions: | AIR 1.0

Calling the `checkStatus()` method of a SocketMonitor object causes the application to try connecting to the socket, to check for a `connect` event.

### createSocket

()
method

`protected function createSocket():Socket`

Runtime Versions: | AIR 1.0

Creates a Socket object.

Returns

| `Socket` — the Socket object to be used by this SocketMonitor.

### toString

()
method

`override public function toString():String`

Runtime Versions: | AIR 1.0

Returns the string representation of the specified object.

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the `override` keyword. For example, a subclass of Object implements `function toString():String` instead of using an override of the base class.

Returns

| `String` — A string representation of the object.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00