flash.net.ServerSocket - Adobe® AIR® API Reference for HTML Developers

window.runtime property	window.runtime.flash.net.ServerSocket

Inheritance	ServerSocket EventDispatcher Object

Runtime Versions:

The ServerSocket class allows code to act as a server for Transport Control Protocol (TCP) connections.

A TCP server listens for incoming connections from remote clients. When a client attempts to connect, the ServerSocket dispatches a connect event. The ServerSocketConnectEvent object dispatched for the event provides a Socket object representing the TCP connection between the server and the client. Use this Socket object for subsequent communication with the connected client. You can get the client address and port from the Socket object, if needed.

Note: Your application is responsible for maintaining a reference to the client Socket object. If you don't, the object is eligible for garbage collection and may be destroyed by the runtime without warning.

To put a ServerSocket object into the listening state, call the listen() method. In the listening state, the server socket object dispatches connect events whenever a client using the TCP protocol attempts to connect to the bound address and port. The ServerSocket object continues to listen for additional connections until you call the close() method.

TCP connections are persistent — they exist until one side of the connection closes it (or a serious network failure occurs). Any data sent over the connection is broken into transmittable packets and reassembled on the other end. All packets are guaranteed to arrive (within reason) — any lost packets are retransmitted. In general, the TCP protocol manages the available network bandwidth better than the UDP protocol. Most AIR applications that require socket communications should use the ServerSocket and Socket classes rather than the DatagramSocket class.

The ServerSocket class can only be used in Adobe AIR applications and only in the application security sandbox.

For more information related to security, see the Flash Player Developer Center Topic: Security.

Properties

Hide Inherited Public Properties

Show Inherited Properties

	Property		Defined By
		bound : Boolean [read-only] Indicates whether the socket is bound to a local address and port.	ServerSocket
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		isSupported : Boolean [static] [read-only] Indicates whether or not ServerSocket features are supported in the run-time environment.	ServerSocket
		listening : Boolean [read-only] Indicates whether the server socket is listening for incoming connections.	ServerSocket
		localAddress : String [read-only] The IP address on which the socket is listening.	ServerSocket
		localPort : int [read-only] The port on which the socket is listening.	ServerSocket
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Methods

	Method		Defined By
		ServerSocket() Creates a ServerSocket object.	ServerSocket
		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
		bind(localPort:int = 0, localAddress:String = "0.0.0.0"):void Binds this socket to the specified local address and port.	ServerSocket
		close():void Closes the socket and stops listening for connections.	ServerSocket
		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
		listen(backlog:int = 0):void Initiates listening for TCP connections on the bound IP address and port.	ServerSocket
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
close	Dispatched when the operating system closes this socket.	ServerSocket
connect	Dispatched when a remote socket seeks to connect to this server socket.	ServerSocket
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

bound

property

bound:Boolean [read-only]

Runtime Versions:

Indicates whether the socket is bound to a local address and port.

See also

bind()

isSupported

property

isSupported:Boolean [read-only]

Runtime Versions:

Indicates whether or not ServerSocket features are supported in the run-time environment.

listening

property

listening:Boolean [read-only]

Runtime Versions:

Indicates whether the server socket is listening for incoming connections.

See also

listen()

localAddress

property

localAddress:String [read-only]

Runtime Versions:

The IP address on which the socket is listening.

See also

bind()

localPort

property

localPort:int [read-only]

Runtime Versions:

The port on which the socket is listening.

See also

bind()

Constructor Detail

ServerSocket

()

Constructor

public function ServerSocket()

Runtime Versions:

Creates a ServerSocket object.

Throws

SecurityError — This error occurs ff the calling content is running outside the AIR application security sandbox.

Method Detail

bind

()

method

public function bind(localPort:int = 0, localAddress:String = "0.0.0.0"):void

Runtime Versions:

Binds this socket to the specified local address and port.

Parameters

	`localPort:int` (default = `0`) — The number of the port to bind to on the local computer. If `localPort`, is set to 0 (the default), the next available system port is bound. Permission to connect to a port number below 1024 is subject to the system security policy. On Mac and Linux systems, for example, the application must be running with root privileges to connect to ports below 1024.

	`localAddress:String` (default = "`0.0.0.0`") — The IP address on the local machine to bind to. This address can be an IPv4 or IPv6 address. If `localAddress` is set to `0.0.0.0` (the default), the socket listens on all available IPv4 addresses. To listen on all available IPv6 addresses, you must specify "::" as the `localAddress` argument. To use an IPv6 address, the computer and network must both be configured to support IPv6. Furthermore, a socket bound to an IPv4 address cannot connect to a socket with an IPv6 address. Likewise, a socket bound to an IPv6 address cannot connect to a socket with an IPv4 address. The type of address must match.

Throws

	`RangeError` — This error occurs when `localPort` is less than 0 or greater than 65535.

	`ArgumentError` — This error occurs when `localAddress` is not a syntactically well-formed IP address.

	`IOError` — when the socket cannot be bound, such as when: the underlying network socket (IP and port) is already in bound by another object or process. the application is running under a user account that does not have the privileges necessary to bind to the port. Privilege issues typically occur when attempting to bind to well known ports (`localPort` < 1024) this ServerSocket object is already bound. (Call `close()` before binding to a different socket.) when `localAddress` is not a valid local address.

close

()

method

public function close():void

Runtime Versions:

Closes the socket and stops listening for connections.

Closed sockets cannot be reopened. Create a new ServerSocket instance instead.

Throws

Error — This error occurs if the socket could not be closed, or the socket was not open.

listen

()

method

public function listen(backlog:int = 0):void

Runtime Versions:

Initiates listening for TCP connections on the bound IP address and port.

The listen() method returns immediately. Once you call listen(), the ServerSocket object dispatches a connect event whenever a connection attempt is made. The socket property of the ServerSocketConnectEvent event object references a Socket object representing the server-client connection.

The backlog parameter specifies how many pending connections are queued while the connect events are processed by your application. If the queue is full, additional connections are denied without a connect event being dispatched. If the default value of zero is specified, then the system-maximum queue length is used. This length varies by platform and can be configured per computer. If the specified value exceeds the system-maximum length, then the system-maximum length is used instead. No means for discovering the actual backlog value is provided. (The system-maximum value is determined by the SOMAXCONN setting of the TCP network subsystem on the host computer.)

Parameters

backlog:int (default = 0) — The maximum length of the queue of pending connections. If backlog is 0, the queue length is set to the maximum system value.

Throws

	`IOError` — This error occurs if the socket is not open or bound. This error also occurs if the call to `listen()` fails for any other reason.

	`RangeError` — This error occurs if the `backlog` parameter is less than zero.

Event Detail

close

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CLOSE

Runtime Versions:

Dispatched when the operating system closes this socket.

The close event is not dispatched when the ServerSocket close() method is called. If other objects in your application rely on the close event, you can dispatch the event manually before calling the close() method.

The Event.CLOSE constant defines the value of the type property of a close event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object whose connection has been closed.

connect

Event

Event Object Type: flash.events.ServerSocketConnectEvent
property ServerSocketConnectEvent.type = flash.events.ServerSocketConnectEvent.CONNECT

Runtime Versions:

Dispatched when a remote socket seeks to connect to this server socket.

Defines the value of the type property of a ServerSocketConnectEvent event object.

This event has the following properties:

Property	Value
`bubbles`	`false`.
`cancelable`	`false`, there is no default behavior to cancel.
`currentTarget`	This ServerSocket object.
`target`	This ServerSocket object.
`socket`	The Socket object representing the new connection.

[an error occurred while processing this directive][an error occurred while processing this directive]

Legal Notices | Online Privacy Policy