flash.events

# ServerSocketConnectEvent - AS3

Package | flash.events
Class | public class ServerSocketConnectEvent
Inheritance | ServerSocketConnectEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts to connect to the server socket.

The `socket` property of the ServerSocketConnectEvent object provides the Socket object to use for subsequent communication between the server and the client. To deny the connection, call the Socket `close()` method.

Related API Elements

ServerSocket class

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | socket : Socket The socket for the new connection. | ServerSocketConnectEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ServerSocketConnectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, socket:Socket = null) Creates a ServerSocketConnectEvent object that contains information about a client connection. | ServerSocketConnectEvent
|  | clone():Event [override] Creates a copy of the ServerSocketConnectEvent object and sets each property's value to match that of the original. | ServerSocketConnectEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the ServerSocketConnectEvent object. | ServerSocketConnectEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CONNECT : String = "connect" [static] Defines the value of the type property of a ServerSocketConnectEvent event object. | ServerSocketConnectEvent

Property Detail

### socket

property

`socket:Socket`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The socket for the new connection.

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

Implementation
`public function get socket():Socket`
`public function set socket(value:Socket):void`
Constructor Detail

### ServerSocketConnectEvent

()
Constructor

`public function ServerSocketConnectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, socket:Socket = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Creates a ServerSocketConnectEvent object that contains information about a client connection.

Parameters

| `type:String` — The type of the event. Must be: `ServerSocketConnectEvent.CONNECT`.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow. Always `false`
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled. Always `false`.
| `socket:Socket` (default = `null`)`` — The socket for the new connection.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Creates a copy of the ServerSocketConnectEvent object and sets each property's value to match that of the original.

Returns

| `Event` — A new ServerSocketConnectEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Returns a string that contains all the properties of the ServerSocketConnectEvent object.

The string is in the following format:

`[ServerSocketConnectEvent type=value bubbles=value cancelable=value socket=value]`

Returns

| `String` — A string that contains all the properties of the `ServerSocketConnectEvent` object.

Constant Detail

### CONNECT

Constant

`public static const CONNECT:String = "connect"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

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.

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