NetConnection class

Availability

Flash Communication Server 1.

Returns

A NetConnection object.

Example

The following example creates a new instance of the NetConnection class:

newNC = new NetConnection();

Availability

Flash Communication Server 1

Parameters

name

A string; identifies the header and the ActionScript object data associated with it.

mustUnderstand

A boolean; true indicates that the server must understand and process this header before it handles any of the following headers or messages.

object

An Object.

Example

The following example creates a new NetConnection instance, nc, and connects to an application at web server www.foo.com that is listening at port 1929. This application dispatches the service /blag/SomeCoolService. The last line of code adds a header called foo.

nc=new NetConnection(); 
nc.connect("http://www.foo.com:1929/blag/SomeCoolService"); 
nc.addHeader("foo", true, new Foo());

Availability

Flash Communication Server 1

Parameters

methodName

A string indicating a method specified in the form "[objectPath/]method". For example, the someObj/doSomething command tells the remote server to invoke the clientObj.someObj.doSomething() method, with all the p1, ..., pN parameters. If the object path is missing, clientObj.doSomething() is invoked on the remote server.

resultObj

An Object. This optional parameter is used to handle return values from the server. The result object can be any object that you defined and can have two defined methods to handle the returned result: onResult() and onStatus(). If an error is returned as the result, onStatus() is invoked; otherwise, onResult() is invoked.

p1, ..., pN

Optional parameters that can be of any ActionScript type, including a reference to another ActionScript object. These parameters are passed to the methodName parameter when the method is executed on the remote application server.

Returns

For RTMP connections, returns a boolean value of true if a call to methodName is sent to the client; otherwise, false. For application server connections, it always returns true.

Example

The following example uses RTMP to execute a call from one Flash Media Server to another Flash Media Server. The code makes a connection to the App1 application on server 2 and then invokes the Sum() method on server 2:

nc1.connect("rtmp://server2.mydomain.com/App1", "svr2",); 
nc1.call("Sum", new Result(), 3, 6);

The following Server-Side ActionScript code is on server 2. When the client is connecting, this code checks to see whether it has a parameter that is equal to svr1. If the client has that parameter, the Sum() method is defined so that when the method is called from svr1, svr2 can respond with the appropriate method:

application.onConnect = function(clientObj){ 
    if(arg1 == "svr1"){ 
        clientObj.Sum = function(p1, p2){ 
            return p1 + p2; 
        } 
    }  
    return true;  
};

The following example uses an Action Message Format (AMF) request to make a call to an application server. This allows Flash Media Server to connect to an application server and then invoke the quote() method. The Java™ adaptor dispatches the call by using the identifier to the left of the dot as the class name and the identifier to the right of the dot as a method of the class.

nc = new NetConnection; 
nc.connect("http://www.xyz.com/java"); 
nc.call("myPackage.quote", new Result());

Availability

Flash Communication Server 1

Availability

Flash Communication Server 1

Parameters

URI  A string indicating a URI to connect to. URI has the following format:

[protocol://]host[:port]/appName[/instanceName]

The following are legal URIs:

http://appServer.mydomain.com/webApp 
rtmp://rtserver.mydomain.com/realtimeApp 
rtmps://rtserver.mydomain.com/secureApp 
rtmp://localhost/realtimeApp 
rtmp:/realtimeApp

p1, ..., pN

Optional parameters that can be of any ActionScript type, including references to other ActionScript objects. These parameters are sent as connection parameters to the application.onConnect() event handler for RTMP connections. For AMF connections to application servers, RTMP parameters are ignored.

Returns

For RTMP connections, a boolean value of true for success; otherwise, false. For AMF connections to application servers, true is always returned.

Example

The following example creates an RTMP connection to an application instance on Flash Media Server:

nc = new NetConnection(); 
nc.connect("rtmp://tc.foo.com/myApp/myConn");

Availability

Flash Communication Server 1

Example

The following example uses NetConnection.isConnected in an onStatus() handler to check whether a connection has been made:

nc = new NetConnection(); 
nc.connect("rtmp://tc.foo.com/myApp"); 
nc.onStatus = function(infoObj){ 
    if (info.code == "NetConnection.Connect.Success" && nc.isConnected){ 
        trace("We are connected"); 
    } 
};

Availability

Flash Media Interactive Server 3 and Flash Media Development Server 3

Availability

Flash Communication Server 1

Parameters

infoObject

An Object with properties that provide information about the status of a NetConnection information object. This parameter is optional, but it is usually used. The NetConnection information object contains the following properties:

Property	Meaning
code	A string identifying the event that occurred.
description	A string containing detailed information about the code. Not every information object includes this property.
level	A string indicating the severity of the event.

The following table contains the code and level property values and their meanings:

Code	Level	Meaning
NetConnection.Call.Failed	error	The NetConnection.call() method was not able to invoke the server-side method or command.
NetConnection.Connect.AppShutdown	error	The application has been shut down (for example, if the application is out of memory resources and must shut down to prevent the server from crashing) or the server has shut down.
NetConnection.Connect.Closed	status	The connection was closed successfully.
NetConnection.Connect.Failed	error	The connection attempt failed.
NetConnection.Connect.Rejected	error	The client does not have permission to connect to the application, or the application name specified during the connection attempt was not found on the server. This information object also has an application property that contains the value returned by application.rejectConnection().
NetConnection.Connect.Success	status	The connection attempt succeeded.
NetConnection.Proxy.NotResponding	error	The proxy server is not responding. See the ProxyStream class.

Example

The following example defines a function for the onStatus() handler that outputs messages to indicate whether the connection was successful:

nc = new NetConnection(); 
nc.onStatus = function(info){ 
    if (info.code == "NetConnection.Connect.Success") { 
        _root.gotoAndStop(2); 
    }    else { 
        if (! nc.isConnected){ 
            _root.gotoAndStop(1); 
        } 
    } 
};

Availability

Flash Communication Server 1