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 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

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

See also

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.

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, the status of the connection is reported by an event. If the socket is already connected, the existing connection is closed first.

By default, the value you pass for host must be in the same domain and the value you pass for port must be 1024 or higher. For example, a SWF file at adobe.com can connect only to a server daemon running at adobe.com. If you want to connect to a socket on a different host than the one from which the connecting SWF file was served, or if you want to connect to a port lower than 1024 on any host, you must obtain an xmlsocket: policy file from the host to which you are connecting. Howver, these restrictions do not exist for AIR content in the application security sandbox. For more information, see the "Flash Player Security" chapter in Programming ActionScript 3.0.

Parameters

Flushes any accumulated data in the socket's output buffer. Data written by the write methods is not immediately transmitted; it is queued until the flush() method is called.

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 string is assumed to be 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).

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

Writes a byte to the socket.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

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 entire buffer is written.

If offset or length is out of range, they are adjusted to match the beginning and end of the bytes array.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

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

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

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

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

Writes a 32-bit signed integer to the socket.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

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

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

Write an object to the socket in AMF serialized format.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

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.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

Writes a 32-bit unsigned integer to the socket.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

Writes the following data to the socket: a 16-bit unsigned integer, which indicates the length of the specified UTF-8 string in bytes, followed by the string itself.

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

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

Parameters

See also

Writes a UTF-8 string to the socket.

Note: Data written by this method is not immediately transmitted; it is queued until the flush() method is called.

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 has been established.

This event has the following properties:

Dispatched when an input/output error occurs that causes a send or load operation to fail.

This event has the following properties:

Dispatched if a call to Socket.connect() attempts to connect either to a server outside the caller's security sandbox or to a port lower than 1024.

This event has the following properties:

See also

Dispatched when a socket has received data. Events of type socketData do not use the ProgressEvent.bytesTotal property.

This event has the following properties:

1. The constructor creates a CustomSocket instance named socket and passes the host name localhost and port 80 as arguments. Since CustomSocket extends Socket, a call to super() calls Socket's constructor with localhost as the host name and 80 as the port number.
2. The example then calls the configureListeners() method, which adds listeners for Socket events.

Note: To run the example, you need a server running on the same domain where the SWF resides (in the example, localhost) and listening on port 80.

package {
    import flash.display.Sprite;

    public class SocketExample extends Sprite {

        public function SocketExample() {
            var socket:CustomSocket = new CustomSocket("localhost", 80);
        }
    }
}

import flash.errors.*;
import flash.events.*;
import flash.net.Socket;

class CustomSocket extends Socket {
    private var response:String;

    public function CustomSocket(host:String = null, port:uint = 0) {
        super(host, port);
        configureListeners();
    }

    private function configureListeners():void {
        addEventListener(Event.CLOSE, closeHandler);
        addEventListener(Event.CONNECT, connectHandler);
        addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
        addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
        addEventListener(ProgressEvent.SOCKET_DATA, socketDataHandler);
    }

    private function writeln(str:String):void {
        str += "\n";
        try {
            writeUTFBytes(str);
        }
        catch(e:IOError) {
            trace(e);
        }
    }

    private function sendRequest():void {
        trace("sendRequest");
        response = "";
        writeln("GET /");
        flush();
    }

    private function readResponse():void {
        var str:String = readUTFBytes(bytesAvailable);
        response += str;
    }

    private function closeHandler(event:Event):void {
        trace("closeHandler: " + event);
        trace(response.toString());
    }

    private function connectHandler(event:Event):void {
        trace("connectHandler: " + event);
        sendRequest();
    }

    private function ioErrorHandler(event:IOErrorEvent):void {
        trace("ioErrorHandler: " + event);
    }

    private function securityErrorHandler(event:SecurityErrorEvent):void {
        trace("securityErrorHandler: " + event);
    }

    private function socketDataHandler(event:ProgressEvent):void {
        trace("socketDataHandler: " + event);
        readResponse();
    }
}