ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.net 

NetConnectionFactory  - AS3 OSMF
Packageorg.osmf.net
Classpublic class NetConnectionFactory
InheritanceNetConnectionFactory Inheritance NetConnectionFactoryBase Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The NetConnectionFactory class is used to generate connected NetConnection instances and to manage sharing of these instances. The NetConnectionFactory can also handle port/protocol negotiation.

NetConnectionFactory is stateless. Multiple parallel create() requests may be made. A hash of the resource URL is used as a key to determine which NetConnections may be shared.


Public Properties
 PropertyDefined By
  connectionAttemptInterval : Number
NetConnectionFactory
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  timeout : Number
NetConnectionFactory
Public Methods
 MethodDefined By
  
NetConnectionFactory(shareNetConnections:Boolean = true)
Constructor.
NetConnectionFactory
 Inherited
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
 Inherited
closeNetConnection(netConnection:NetConnection):void
Closes the given NetConnection.
NetConnectionFactoryBase
 Inherited
create(resource:URLResource):void
Begins the process of creating a new NetConnection and establishing the connection.
NetConnectionFactoryBase
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 MethodDefined By
  
createNetConnection():NetConnection
The factory function for creating a NetConnection.
NetConnectionFactory
  
createNetConnectionKey(resource:URLResource):String
Generates a key to uniquely identify each connection.
NetConnectionFactory
  
createNetConnectionURLs(url:String, urlIncludesFMSApplicationInstance:Boolean = false):Vector.<String>
Assembles a vector of URLs that should be used during the connection attempt.
NetConnectionFactory
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
creationComplete
Dispatched when the factory has successfully created and connected a NetConnection.NetConnectionFactoryBase
 Inherited
creationError
Dispatched when the factory has failed to create and connect a NetConnection.NetConnectionFactoryBase
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

connectionAttemptInterval

property
connectionAttemptInterval:Number



Implementation
    public function get connectionAttemptInterval():Number
    public function set connectionAttemptInterval(value:Number):void

timeout

property 
timeout:Number



Implementation
    public function get timeout():Number
    public function set timeout(value:Number):void
Constructor Detail

NetConnectionFactory

()Constructor
public function NetConnectionFactory(shareNetConnections:Boolean = true)

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
shareNetConnections:Boolean (default = true) — Boolean specifying whether created NetConnections may be shared or not. The default is true.
Method Detail

createNetConnection

()method
protected function createNetConnection():NetConnection

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The factory function for creating a NetConnection.

Returns
NetConnection — An unconnected NetConnection.

Related API Elements

flash.net.NetConnection

createNetConnectionKey

()method 
protected function createNetConnectionKey(resource:URLResource):String

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Generates a key to uniquely identify each connection. This key is used to determine whether a particularly URLResource can share an existing NetConnection. If the keys for two URLResources are identical, then they can share the same NetConnection. By default, this method returns a String consisting of the protocol, host, port, and FMS application name.

Parameters

resource:URLResource — a URLResource

Returns
String — a String hash that uniquely identifies the NetConnection

createNetConnectionURLs

()method 
protected function createNetConnectionURLs(url:String, urlIncludesFMSApplicationInstance:Boolean = false):Vector.<String>

Assembles a vector of URLs that should be used during the connection attempt. The default protocols attempted when a "rtmp" connection is specified are "rtmp", "rtmps", and "rtmpt". When a "rtmpe" connection is requested, both "rtmpe" and "rtmpte" protocols are attempted. When "rtmps","rtmpt" or "rtmpte" are requested, only those protocols are attempted. The default ports are 1935, 443 and 80. If a specific port is specified in the URL, then only that port is used. Subclasses can override this method to change this default behavior.

Parameters

url:String — The URL to be loaded.
 
urlIncludesFMSApplicationInstance:Boolean (default = false) — Indicates whether the URL includes the FMS application instance name. See StreamingURLResource for more info.

Returns
Vector.<String>



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy