flash.events

# DatagramSocketDataEvent - AS3

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

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

A DatagramSocketDataEvent object is dispatched when Datagram socket has received data.

Related API Elements

DatagramSocket 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
|  | data : ByteArray The datagram packet data. | DatagramSocketDataEvent
|  | dstAddress : String The IP address of the DatagramSocket object that dispatched this event. | DatagramSocketDataEvent
|  | dstPort : int The port of the DatagramSocket object that dispatched this event. | DatagramSocketDataEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | srcAddress : String The IP address of the machine that sent the packet. | DatagramSocketDataEvent
|  | srcPort : int The port on the machine that sent the packet. | DatagramSocketDataEvent
|  | 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
--- | --- | ---
|  | DatagramSocketDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, srcAddress:String = "", srcPort:int = 0, dstAddress:String = "", dstPort:int = 0, data:ByteArray = null) Creates an Event object that contains information about datagram events. | DatagramSocketDataEvent
|  | clone():Event [override] Creates a copy of the DatagramSocketDataEvent object and sets each property's value to match that of the original. | DatagramSocketDataEvent
|  | 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 DatagramSocketDataEvent object. | DatagramSocketDataEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DATA : String = "data" [static] Defines the value of the type property of a data event object. | DatagramSocketDataEvent

Property Detail

### data

property

`data:ByteArray`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The datagram packet data.

Implementation
`public function get data():ByteArray`
`public function set data(value:ByteArray):void`

### dstAddress

property

`dstAddress:String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The IP address of the DatagramSocket object that dispatched this event.

Note: If the socket is bound to the special address: `0.0.0.0`, then this property will return `0.0.0.0`. In order to know the specific IP to which the datagram message is sent, you must bind the socket to an explicit IP address.

Implementation
`public function get dstAddress():String`
`public function set dstAddress(value:String):void`

### dstPort

property

`dstPort:int`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The port of the DatagramSocket object that dispatched this event.

Implementation
`public function get dstPort():int`
`public function set dstPort(value:int):void`

### srcAddress

property

`srcAddress:String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The IP address of the machine that sent the packet.

Implementation
`public function get srcAddress():String`
`public function set srcAddress(value:String):void`

### srcPort

property

`srcPort:int`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The port on the machine that sent the packet.

Implementation
`public function get srcPort():int`
`public function set srcPort(value:int):void`
Constructor Detail

### DatagramSocketDataEvent

()
Constructor

`public function DatagramSocketDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, srcAddress:String = "", srcPort:int = 0, dstAddress:String = "", dstPort:int = 0, data:ByteArray = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Creates an Event object that contains information about datagram events. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event. Possible values are:`DatagramSocketDataEvent.DATA`
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled.
| `srcAddress:String` (default = "``")`` — The IP address of the machine that sent the packet.
| `srcPort:int` (default = `0`)`` — The port on the machine that sent the packet.
| `dstAddress:String` (default = "``")`` — The IP address to which the packet is addressed.
| `dstPort:int` (default = `0`)`` — The port to which the packet is addressed.
| `data:ByteArray` (default = `null`)`` — The datagram packet data.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

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

Returns

| `Event` — A new DatagramSocketDataEvent 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 DatagramSocketDataEvent object. The string is in the following format:

`[DatagramSocketDataEvent type=value bubbles=value cancelable=value srcAddress=value srcPort=value dstAddress=value dstPort=value data=value]`

Returns

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

Constant Detail

### DATA

Constant

`public static const DATA:String = "data"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Defines the value of the `type` property of a `data` event object.

Related API Elements

flash.net.DatagramSocket.data

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