net.rim.device.api.io
Interface SocketConnectionEnhanced

All Known Implementing Classes:

SSL30Connection, TLS10Connection

public interface SocketConnectionEnhanced

This class is provides extensions to javax.microedition.io.SocketConnection. It provides additional socket configuration abilities.

Sample code

class Protocol implements SocketConnectionEnhanced
{
public void setSocketOptionEx(short option, long value)
{
// If stream is not closed :
if (option == SocketConnectionEnhanced.READ_TIMEOUT && value >= 0)
{
datagramConnectionBase.setTimeout(value);
return;
}
else
{
// Update custom socket option.
}

}

public long getSocketOptionEx(short option)
{
// If stream is not closed :
if (option == SocketConnectionEnhanced.READ_TIMEOUT)
{
return HttpConnection.HTTP_CLIENT_TIMEOUT;
}
else
{
// Get custom socket option.
}
}
}

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Field Summary
	static short	READ_TIMEOUT Socket option for the time in milliseconds to wait for blocking read calls. (254)

Method Summary
	long	getSocketOptionEx(short option) Get a socket option for this connection.
	void	setSocketOptionEx(short option, long value) Set a socket option for this connection.

Field Detail

READ_TIMEOUT

static final short READ_TIMEOUT

Socket option for the time in milliseconds to wait for blocking read calls. (254)

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Method Detail

setSocketOptionEx

void setSocketOptionEx(short option,
                       long value)
                       throws IllegalArgumentException,
                              IOException

Set a socket option for this connection. This is a extended API allowing more options to be set than the ones available in javax.microedition.io.

Parameters:

option - socket option identifier

value - value for specified option

Throws:

IllegalArgumentException - if the value is not valid (e.g. negative value) or if the option identifier is not valid

IOException - if the connection was closed

See Also:

SocketConnectionEnhanced.getSocketOptionEx(short)

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

getSocketOptionEx

long getSocketOptionEx(short option)
                       throws IllegalArgumentException,
                              IOException

Get a socket option for this connection. This is a extended API allowing more options to be queried than the ones available in javax.microedition.io.

Parameters:

option - socket option identifier

Returns:

numeric value for specified option or -1 if the value is not available.

Throws:

IllegalArgumentException - if the option identifier is not valid

IOException - if the connection was closed

See Also:

SocketConnectionEnhanced.setSocketOptionEx(short, long)

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0