| Package | vegas.net |
| Class | public class Connection |
| Inheritance | Connection  flash.net.NetConnection |
| Implements | Action |
| Property | Defined By | ||
|---|---|---|---|
| callBadVersion : Signaler
This signal emit when a packet encoded in an unidentified format. | Connection | ||
| callFailed : Signaler
This signal emit when the call method was not able to invoke the server-side method or command. | Connection | ||
| callProhibited : Signaler
This signal emit when an Action Message Format (AMF) operation is prevented for security reasons. | Connection | ||
| connectAppShutDown : Signaler
This signal emit when the specified application is shutting down. | Connection | ||
| connectClosed : Signaler
This signal emit when the connection was closed successfully. | Connection | ||
| connectFailed : Signaler
This signal emit when the connection attempt failed. | Connection | ||
| connectInvalidApp : Signaler
This signal emit when the application name specified during connect is invalid. | Connection | ||
| connectNetworkChange : Signaler
This signal emit when the Flash Player has detected a network change, for example, a dropped wireless connection, a successful wireless connection,or a network cable loss. | Connection | ||
| connectRejected : Signaler
This signal emit when the connection attempt did not have permission to access the application. | Connection | ||
| connectSuccess : Signaler
This signal emit when the connection attempt succeeded. | Connection | ||
| delay : Number [read-only]
Indicates the timeout interval duration. | Connection | ||
| finishIt : Signaler
This signal emit when the notifyFinished method is invoked. | Connection | ||
| infoIt : Signaler
This signal emit when the notifyInfo method is invoked. | Connection | ||
| phase : String [read-only]
The current phase of the action. | Connection | ||
| running : Boolean [read-only]
Indicates true if the process is in progress. | Connection | ||
| startIt : Signaler
This signal emit when the notifyStarted method is invoked. | Connection | ||
| timeoutPolicy : TimeoutPolicy
Indicates the timeout policy of the connection (TimeoutPolicy.LIMIT or TimeoutPolicy.INFINITY)
| Connection | ||
| uri : String [override]
The URI of the application server that was passed to NetConnection.connect(), if connect was used to connect to a server. | Connection | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new Connection instance. | Connection | ||
clone():*
Returns the shallow copy of this object. | Connection | ||
close():void [override]
Closes the connection that was opened locally or with the server and dispatches the netStatus event with a code property of NetConnection.Connect.Closed. | Connection | ||
connect(command:String, ... arguments):void [override]
Connect the client with this method. | Connection | ||
notifyFinished():void
Notify when the connection is finished. | Connection | ||
notifyInfo(info:*):void
Notify a specific information when the process is changed. | Connection | ||
notifyStarted():void
Notify when the connection is started. | Connection | ||
notifyTimeOut():void
Notify when the connection is out of time. | Connection | ||
registerEventListener(type:String, listener:*, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an system.events.EventListener object with an system.events.EventDispatcher object so that the listener receives notification of an event. | Connection | ||
run(... arguments):void
Runs the process. | Connection | ||
setDelay(delay:Number, useSeconds:Boolean):void
Set timeout interval duration. | Connection | ||
unregisterEventListener(type:String, listener:*, useCapture:Boolean = false):void
Removes an system.events.EventListener from the system.events.EventDispatcher object. | Connection | ||
| Method | Defined By | ||
|---|---|---|---|
setRunning(b:Boolean):void
Changes the running property value. | Connection | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when a process is finished. | Connection | |||
| Dispatched when an info process is running. | Connection | |||
| Dispatched when a process is started. | Connection | |||
| Dispatched when a process is out of time. | Connection | |||
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_DELAY : uint = 8000 [static]
The default internal timeout delay value in milliseconds. | Connection | ||
| callBadVersion | property |
callBadVersion:SignalerThis signal emit when a packet encoded in an unidentified format.
public function get callBadVersion():Signaler public function set callBadVersion(value:Signaler):void| callFailed | property |
callFailed:SignalerThis signal emit when the call method was not able to invoke the server-side method or command.
public function get callFailed():Signaler public function set callFailed(value:Signaler):void| callProhibited | property |
callProhibited:SignalerThis signal emit when an Action Message Format (AMF) operation is prevented for security reasons.
public function get callProhibited():Signaler public function set callProhibited(value:Signaler):void| connectAppShutDown | property |
connectAppShutDown:SignalerThis signal emit when the specified application is shutting down.
public function get connectAppShutDown():Signaler public function set connectAppShutDown(value:Signaler):void| connectClosed | property |
connectClosed:SignalerThis signal emit when the connection was closed successfully.
public function get connectClosed():Signaler public function set connectClosed(value:Signaler):void| connectFailed | property |
connectFailed:SignalerThis signal emit when the connection attempt failed.
public function get connectFailed():Signaler public function set connectFailed(value:Signaler):void| connectInvalidApp | property |
connectInvalidApp:SignalerThis signal emit when the application name specified during connect is invalid.
public function get connectInvalidApp():Signaler public function set connectInvalidApp(value:Signaler):void| connectNetworkChange | property |
connectNetworkChange:SignalerThis signal emit when the Flash Player has detected a network change, for example, a dropped wireless connection, a successful wireless connection,or a network cable loss.
public function get connectNetworkChange():Signaler public function set connectNetworkChange(value:Signaler):void| connectRejected | property |
connectRejected:SignalerThis signal emit when the connection attempt did not have permission to access the application.
public function get connectRejected():Signaler public function set connectRejected(value:Signaler):void| connectSuccess | property |
connectSuccess:SignalerThis signal emit when the connection attempt succeeded.
public function get connectSuccess():Signaler public function set connectSuccess(value:Signaler):void| delay | property |
delay:Number [read-only] Indicates the timeout interval duration.
public function get delay():Number| finishIt | property |
finishIt:SignalerThis signal emit when the notifyFinished method is invoked.
public function get finishIt():Signaler public function set finishIt(value:Signaler):void| infoIt | property |
infoIt:SignalerThis signal emit when the notifyInfo method is invoked.
public function get infoIt():Signaler public function set infoIt(value:Signaler):void| phase | property |
phase:String [read-only] The current phase of the action.
public function get phase():StringSee also
| running | property |
running:Boolean [read-only]
Indicates true if the process is in progress.
public function get running():Boolean| startIt | property |
startIt:SignalerThis signal emit when the notifyStarted method is invoked.
public function get startIt():Signaler public function set startIt(value:Signaler):void| timeoutPolicy | property |
timeoutPolicy:TimeoutPolicyIndicates the timeout policy of the connection (TimeoutPolicy.LIMIT or TimeoutPolicy.INFINITY)
public function get timeoutPolicy():TimeoutPolicy public function set timeoutPolicy(value:TimeoutPolicy):voidSee also
| uri | property |
uri:String[override] The URI of the application server that was passed to NetConnection.connect(), if connect was used to connect to a server. If NetConnection.connect() hasn't yet been called or if no URI was passed, this property is undefined. This property is a read-write property and we can use this property in to launch the connect process with the run method.
public function get uri():String public function set uri(value:String):voidSee also
| Connection | () | Constructor |
public function Connection()Creates a new Connection instance.
| clone | () | method |
public function clone():*Returns the shallow copy of this object.
Returns* — the shallow copy of this object.
|
| close | () | method |
override public function close():voidCloses the connection that was opened locally or with the server and dispatches the netStatus event with a code property of NetConnection.Connect.Closed.
| connect | () | method |
override public function connect(command:String, ... arguments):voidConnect the client with this method.
Parameters
command:String | |
... arguments |
| notifyFinished | () | method |
public function notifyFinished():voidNotify when the connection is finished.
| notifyInfo | () | method |
public function notifyInfo(info:*):voidNotify a specific information when the process is changed.
Parameters
info:* |
| notifyStarted | () | method |
public function notifyStarted():voidNotify when the connection is started.
| notifyTimeOut | () | method |
public function notifyTimeOut():voidNotify when the connection is out of time.
| registerEventListener | () | method |
public function registerEventListener(type:String, listener:*, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an system.events.EventListener object with an system.events.EventDispatcher object so that the listener receives notification of an event.
Parameters
type:String | |
listener:* | |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false) |
| run | () | method |
public function run(... arguments):voidRuns the process.
Parameters
... arguments |
| setDelay | () | method |
public function setDelay(delay:Number, useSeconds:Boolean):voidSet timeout interval duration.
Parameters
delay:Number | |
useSeconds:Boolean |
| setRunning | () | method |
protected function setRunning(b:Boolean):voidChanges the running property value.
Parameters
b:Boolean |
| unregisterEventListener | () | method |
public function unregisterEventListener(type:String, listener:*, useCapture:Boolean = false):void
Removes an system.events.EventListener from the system.events.EventDispatcher object.
Parameters
type:String | |
listener:* | |
useCapture:Boolean (default = false) |
| finish | Event |
system.events.ActionEventsystem.events.ActionEvent.FINISHDispatched when a process is finished.
The name of the event when the process is finished.See also
| info | Event |
system.events.ActionEventsystem.events.ActionEvent.INFODispatched when an info process is running.
The name of the event when the process info is changed.See also
| start | Event |
system.events.ActionEventsystem.events.ActionEvent.STARTDispatched when a process is started.
The name of the event when the process is started.See also
| timeout | Event |
system.events.ActionEventsystem.events.ActionEvent.TIMEOUTDispatched when a process is out of time.
The name of the event when the process is cleared.See also
| DEFAULT_DELAY | Constant |
public static const DEFAULT_DELAY:uint = 8000The default internal timeout delay value in milliseconds.