The number of bytes of data available for reading in the input buffer.

Your code must access bytesAvailable to ensure that sufficient data is available before trying to read it with one of the read methods.

Indicates the amount of data (in bytes) awaiting transfer from the socket's write buffer to the network transport layer.

The following operations affect the value of bytesPending:

• A call to Socket.connect() sets bytesPending to zero.
• Adding data to the write buffer via a call to one of the Socket.write*() methods updates bytesPending.
• When the operating system moves data from the write buffer to the network transport layer socket, the system updates bytesPending.
• A call to Socket.close() sets bytesPending to zero (the write buffer is destroyed when you close the socket).

Indicates whether this Socket object is currently connected. A call to this property returns a value of true if the socket is currently connected, or false otherwise.

Indicates the byte order for the data. Possible values are constants from the flash.utils.Endian class, Endian.BIG_ENDIAN or Endian.LITTLE_ENDIAN.

The default value is Endian.BIG_ENDIAN.

See also

The IP address this socket is bound to on the local machine.

See also

The port this socket is bound to on the local machine.

See also

Controls the version of AMF used when writing or reading an object.

See also

The IP address of the remote machine to which this socket is connected.

You can use this property to determine the IP address of a client socket dispatched in a ServerSocketConnectEvent by a ServerSocket object. You can use the DNSResolver class to convert an IP address to a domain name.

See also

The port on the remote machine to which this socket is connected.

You can use this property to determine the port number of a client socket dispatched in a ServerSocketConnectEvent by a ServerSocket object.

See also

Indicates the number of milliseconds to wait for a connection.

If the connection doesn't succeed within the specified time, the connection fails. The default value is 20,000 (20 seconds).

Creates a Socket object. If no parameters are specified, an initially disconnected socket is created. If parameters are specified, a connection is attempted to the specified host and port.

Note: It is strongly advised to use the constructor form without parameters. Next, add event listeners, then call the connect method with host and port parameters. This sequence guarantees that all event listeners work properly.

Closes the socket. You cannot read or write any data after the close() method has been called.

The close event is dispatched only when the server closes the connection; it is not dispatched when you call the close() method.

You can reuse the Socket object by calling the connect() method on it again.

Connects the socket to the specified host and port.

If the connection fails immediately, either an event is dispatched or an exception is thrown. An error event is dispatched if a host was specified, and an exception is thrown if no host was specified. Otherwise, an event reports the status of the connection. If the socket is already connected, the existing connection is closed first.

Note: For best practices on connecting to a socket, see the Socket class description.

Parameters

See also

Flushes any accumulated data in the socket's output buffer.

On some operating systems, flush() is called automatically between execution frames. On other operating systems, such as Windows, the data is never sent unless you call flush() explicitly. It is a good practice to call the flush() method after each write to the socket.

Reads a Boolean value from the socket. After reading a single byte, the method returns true if the byte is nonzero, and false otherwise.

Reads a signed byte from the socket.

Reads the number of data bytes specified by the length parameter from the socket. The bytes are read into the specified byte array, starting at the position indicated by offset.

Parameters

Reads an IEEE 754 double-precision floating-point number from the socket.

Reads an IEEE 754 single-precision floating-point number from the socket.

Reads a signed 32 bit integer from the socket.

Reads a multibyte string from the byte stream, using the specified character set.

Parameters

Reads an object from the socket, encoded in AMF serialized format.

See also

Reads a signed 16 bit integer from the socket.

Reads an unsigned byte from the socket.

Reads an unsigned 32 bit integer from the socket.

Reads an unsigned 16 bit integer from the socket.

Reads a UTF-8 string from the socket. The method expects that the string is prefixed with an unsigned short integer that indicates the length in bytes.

Reads the number of UTF-8 data bytes specified by the length parameter from the socket, and returns a string.

Parameters

Writes a Boolean value to the socket. This method writes a single byte, with either a value of 1 (true) or 0 (false).

Parameters

See also

Writes a byte to the socket.

Parameters

See also

Writes a sequence of bytes from the specified byte array. The write operation starts at the position specified by offset.

If you omit the length parameter the default length of 0 causes the method to write the entire buffer starting at offset.

If you also omit the offset parameter, the method writes the entire buffer.

Parameters

See also

Writes an IEEE 754 double-precision floating-point number to the socket.

Parameters

See also

Writes an IEEE 754 single-precision floating-point number to the socket.

Parameters

See also

Writes a 32 bit signed integer to the socket.

Parameters

See also

Writes a multibyte string from the byte stream, using the specified character set.

Parameters

See also

Writes an object to the socket in AMF serialized format.

Parameters

See also

Writes a 16 bit integer to the socket. The bytes written are as follows:

(v >> 8) & 0xff v & 0xff

The low 16 bits of the parameter are used; the high 16 bits are ignored.

Parameters

See also

Writes a 32 bit unsigned integer to the socket.

Parameters

See also

Writes the following data to the socket:

• A 16 bit unsigned integer. The integer indicates the length in bytes of the specified UTF-8 string.
• The specified UTF-8 string.

Before writing the string, the method calculates the number of bytes necessary to represent all characters of the string.

Parameters

See also

Writes a UTF-8 string to the socket.

Parameters

See also

Dispatched when the server closes the socket connection.

The close event is dispatched only when the server closes the connection. It is not dispatched when you call the Socket.close() method.

This event has the following properties:

Dispatched when a network connection is established.

This event has the following properties:

Dispatched when an IO error causes a send or load operation to fail.

This event has the following properties:

Dispatched when a socket moves data from its write buffer to the networking transport layer. Use the bytesPending property on this event object to determine how much data is pending in the write buffer.

You can use this event to prevent data loss when, for example, a user prematurely closes an application employing sockets. Ensure that the socket property bytesPending equals zero before you close a socket or allow the socket to be garbage-collected.

For more information about this event, along with an example, see Socket Improvements in AIR 3.

This event has the following properties:

Dispatched if a call to Socket.connect() attempts to connect to a server prohibited by the caller's security sandbox. This event is also dispatched if the port ID is lower than 1024 and no socket policy file exists to permit such a connection.

Note: In an AIR application, content running in the application security sandbox can connect without a socket policy file to any server and port number.

This event has the following properties:

See also

Dispatched when a socket receives data.

The data received by the socket remains in the socket until it is read. You can read all or some of the received data upon notification of this event.

Note: Events of type socketData do not use the ProgressEvent.bytesTotal property.

This event has the following properties:

Note: To test this example, do the following:

1. Add the AIRAliases.js file to the project directory.
2. Change the code so that the Socket() constructor points to a valid URL and port.
3. Create an application descriptor file for the project, and test the project using ADL.

<html>
<head>
    <script src="AIRAliases.js" />
    <script>
    var socket;
    var response;
    function init() {
        socket = new air.Socket("localhost", 80);
        socket.addEventListener(air.Event.CLOSE, closeHandler);
        socket.addEventListener(air.Event.CONNECT, connectHandler);
        socket.addEventListener(air.IOErrorEvent.IO_ERROR, ioErrorHandler);
        socket.addEventListener(air.SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
        socket.addEventListener(air.ProgressEvent.SOCKET_DATA, socketDataHandler);
    }
    function writeln(str) {
        str += "\n";
        try {
            socket.writeUTFBytes(str);
        }
        catch(e) {
            air.trace(e);
        }
    }
    function sendRequest() {
        air.trace("sendRequest");
        response = "";
        writeln("GET /");
        socket.flush();
    }
    function readResponse() {
        var str = socket.readUTFBytes(socket.bytesAvailable);
        response += str;
    }
    function closeHandler(event) {
        air.trace("closeHandler: " + event);
        air.trace(response.toString());
    }
    function connectHandler(event) {
        air.trace("connectHandler: " + event);
        sendRequest();
    }
    function ioErrorHandler(event) {
        air.trace("ioErrorHandler: " + event);
    }
    function securityErrorHandler(event) {
        air.trace("securityErrorHandler: " + event);
    }
    function socketDataHandler(event) {
        air.trace("socketDataHandler: " + event);
        readResponse();
    }
    </script>
</head>
<body onload='init()'>
</body>
</html>