RSocket Class Reference

Default Constructor

Facilitates a client/server connection from a remote socket.

Extracts the first pending connection on a queue of sockets, the queue size being previously specified by Listen(). On successful completion the blank socket is given the handle of the new socket and it may then be used to transfer data. After completion the accept socket may be used to make further connections with new blank sockets (see Open() on how to open a blank socket).

Accept() may be used for protocols which do not have the KSIConnectionLess flag in their protocol information.

Facilitates a client/server connection from a remote socket.

Extracts the first pending connection on a queue of sockets, the queue size being previously specified by Listen(). On successful completion the blank socket is given the handle of the new socket and it may then be used to transfer data. After completion the accept socket may be used to make further connections with new blank sockets (see Open() on how to open a blank socket).

This variant provides an additional descriptor argument to receive data which may have been sent in a connect request. If there is a pending connection in the listen queue when Accept() is called, the call will complete immediately. Otherwise it will wait until a socket becomes available in the queue and complete asynchronously.

Accept() may be used for protocols which do not have the KSIConnectionLess flag in their protocol information.

To receive data-in accepting, a protocol must have the flag KSIConnectData in its protocol information.

Sets the local address of a socket.

When a socket is opened it has no name associated with it, and binding is required so data can be routed to the socket.

Bind() should be called before Listen() or Connect(). The address supplied should be a derived class specific to the particular protocol the socket was opened on.

Cancels an outstanding accept operation.

Will cause any outstanding accept operation to complete prematurely.

Cancels all outstanding operations.

Will cause all outstanding operations to complete prematurely.

Outstanding operations for a socket include: read, write, Ioctl, connect, accept and shutdown. All of these operations will be completed by this call.

Cancels an outstanding connect operation.

Will cause any outstanding connect operation to complete prematurely.

The state of a socket after a connect is cancelled is defined by the characteristics of the protocol.

Cancels an outstanding Ioctl() operation.

Will cause any outstanding Ioctl operation to complete prematurely.

The state of a socket after a connect is cancelled is defined by the characteristics of the protocol.

Cancels an outstanding Read() operation.

Calling this function will cause any outstanding Read() operation to complete prematurely. The state of a socket after a receive is cancelled is defined by the characteristics of the protocol.

Cancels an outstanding Recv() operation.

Calling this function will cause any outstanding receive operation to complete prematurely. The state of a socket after a receive is cancelled is defined by the characteristics of the protocol.

Cancels an outstanding Send() operation.

Calling the function will cause any outstanding send operation to complete prematurely. The state of a socket after a send is cancelled is defined by the characteristics of the protocol.

Cancels an outstanding Write() operation.

Calling the function will cause any outstanding Write() operation to complete prematurely. The state of a socket after a send is cancelled is defined by the characteristics of the protocol.

Closes a socket.

If a socket has been opened using Open() then it should be closed using Close(). This will ensure all associated resources are released.

Closing serves two distinct purposes:

To release resources associated with the IPC channel to the socket server.

To disconnect a socket if it is connected.

If a socket is connected, then calling close is equivalent to calling Shutdown() with an argument of RSocket::ENormal, synchronously waiting for the request to complete, and then closing the IPC channel. If asynchronous or alternative methods of disconnecting are required then Shutdown() should be called before Close().

If the RSocketServ session on which a protocol was opened is closed, then all sockets associated with that session will be abortively closed and any further requests on the sockets will result in panics.

If a protocol has the flag KSIGracefulClose in its protocol information, when Close() is called on a connected socket, the socket will synchronously block until a response to a close request has been received or some other protocol condition causes the call to complete.

Connects to a remote host asynchronously.

The address provided specifies the address of the remote host.

A socket may only have one connect operation outstanding at any one time. Once the connect is completed, the socket is ready to send or receive data. If a socket is unbound - i.e. Bind() has not been called yet - then it will automatically have a local address allocated.

Connect() is always required for protocols which do not have the KSIConnectionLess flag in their protocol information. If a protocol has the KSIConnectionLess flag, then Connect() may be used to set the address for all data sent from the socket, in which case Send()/Write() may be used in addition to SendTo().

To use data in connection a protocol must have the flag KSIConnectData in its protocol information.

To cancel a connect use CancelConnect().

Connects to a remote host asynchronously.

The address provided specifies the address of the remote host.

Some protocols allow data to be sent in connect request packets which may be provided in the data-out descriptor. Some protocols may allow data to be sent in connect responses which may be collected in the data-in descriptor.

A socket may only have one connect operation outstanding at any one time. Once the connect is completed, the socket is ready to send or receive data. If a socket is unbound - i.e. Bind() has not been called yet - then it will automatically have a local address allocated.

Connect() is always required for protocols which do not have the KSIConnectionLess flag in their protocol information. If a protocol has the KSIConnectionLess flag, then Connect() may be used to set the address for all data sent from the socket, in which case Send()/Write() may be used in addition to SendTo().

To use data in connection a protocol must have the flag KSIConnectData in its protocol information.

To cancel a connect use CancelConnect().

Gets data for use in the disconnection of a socket, namely the remote name of the connected socket.

This data has been received in a protocol disconnect message.

To use the data in disconnection, a protocol must have the flagKSIConnectData in its protocol information.

Gets a socket option. The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be got with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Gets a socket option. The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be got with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Gets information in the protocol description for the protocol which a socket is opened on.

Applies an asynchronous I/O control operation on a socket. Data may be passed and received if a descriptor address is provided as an argument. Only one Ioctl() operation may be outstanding for each socket.

Commands available for all protocols can be set withaLevel set to KSOLSocket. See individual protocol notes for other commands.

Sets up a socket to listen for incoming connections.

Before calling this procedure a socket should be opened on a specific protocol using Open() and the socket should be bound to a local address using Bind().

Listen() creates a queue to hold incoming connections which can be married with blank sockets using Accept(). The call also allows data to be sent back to connecting peers if a protocol allows data to be passed in connect responses. Once a listen queue has been created it will continue to allow peers to connect until it is full, at which point it will reject any incoming connections as specified by protocol behaviour. When a socket is accepted by the client a space is made available in the queue.

Sets up a socket to listen for incoming connections.

Before calling this procedure a socket should be opened on a specific protocol using Open() and the socket should be bound to a local address using Bind().

Listen() creates a queue to hold incoming connections which can be married with blank sockets using Accept(). The call also allows data to be sent back to connecting peers if a protocol allows data to be passed in connect responses. Once a listen queue has been created it will continue to allow peers to connect until it is full, at which point it will reject any incoming connections as specified by protocol behaviour. When a socket is accepted by the client a space is made available in the queue.

To use data-in listening, a protocol must have the flag KSIConnectData in its protocol information.

Gets the local address of a bound socket.

The local address is set either by calling Bind(), or is automatically set when Connect() is called.

If a socket is created through Accept() then a socket will inherit the port of its parent unless otherwise specified by a protocol's behaviour.

Depending on a protocol implementation, additional information may be gained through this call.

Gets the local port number of a bound socket.

Getting the local port is similar to getting the local name.

See also: LocalName() for a description.

Gets a unique system name for the socket. The purpose of this is to identify the socket in a call to Transfer().

Opens an implicit socket by creating a new subsession to the socket server. Implicit socket is not explicitly associated with any connection. The socket will choose the default connection for sending the packets.

Implicit socket accepts packets routed through any connection.

Opens a channel to a protocol identified by a tuple of constants. If a socket is the first to be opened for a protocol it will have the additional effect of loading the protocol in the socket server.

Applications attempting to exercise the default connection scenario shall (from 9.3 onwards) receive an error from RSocket::Open(...). The actual error code is yet to be defined.

Opens an explicit socket by creating a new subsession to the socket server. The socket is explicitly associated with the same underlying connection as an existing RConnection instance.

Socket traffic is directed to and from the specified connection only.

Opens an explicit socket by creating a new subsession to the socket server. The socket is explicitly associated with the same underlying connection as an existing RSubConnection instance.

Socket traffic is directed to and from the specified connection only.

since 7.0S

Opens an implicit socket by creating a new subsession to the socket server. Implicit socket is not explicitly associated with any connection. The socket will choose the default connection for sending the packets.

Implicit socket accepts packets routed through any connection.

Opens a channel to a protocol identified by a name. If a socket is the first to be opened for a protocol it will have the additional effect of loading the protocol in the socket server.

Applications attempting to exercise the default connection scenario shall (from 9.3 onwards) receive an error from RSocket::Open(...). The actual error code is yet to be defined.

Opens an implicit socket by creating a new subsession to the socket server. Implicit socket is not explicitly associated with any connection. The socket will choose the default connection for sending the packets.

Implicit socket accepts packets routed through any connection.

Provides a blank channel to the socket server which has no protocol associated. A socket opened in this manner is suitable as an argument to Accept(), which will marry the blank socket to a protocol when a connection is established to a remote endpoint.

Receives data from a remote host.

For a stream-interfaced sockets, the function only completes when the full amount of requested data has been received (or the connection breaks). This means when the descriptor has been filled to its maximum length (not its current length). For a connection-oriented datagram-interface, the function completes when a datagram arrives even if it is not sufficient to fill the buffer.

Read() should only be used with connected sockets.

A socket may only have one receive operation outstanding at any one time.

Receives data from a remote host, allowing flags for protocol specific information.

For a stream-interfaced socket the function only completes when the full amount of requested data has been received (or the connection breaks). This means when the descriptor has been filled to its maximum length (not its current length).

For a datagram-interface socket, the function completes when one datagram arrives - even if it is not sufficient to fill the buffer. If the datagram does not fit in the buffer supplied then the remaining data will be lost.

Recv() should only be used with connected sockets.

A socket may only have one receive operation outstanding at any one time.

If a protocol's information flag is marked with KSIPeekData, then KSockReadPeek may be provided as a flag to Recv(). All other flags are protocol specific.

Receives data from a remote host, allowing flags for protocol specific information.

For a stream-interfaced sockets, the function only completes when the full amount of requested data has been received (or the connection breaks). This means when the descriptor has been filled to its maximum length (not its current length).

For a datagram-interface socket, the function completes when one datagram arrives - even if it is not sufficient to fill the buffer. If the datagram does not fit in the buffer supplied, remaining data may be retrieved using the Datagram Continuation feature.

This function implements the Datagram Continuation feature for PRTs implementing PRT1.5: the ability to read a datagram in parts. For a client request to read a datagram, using the TSockXfrLength parameter, remaining unread octets of the datagram are returned in the TSockXfrLength parameter. The client can then read the remaining octets by further reads with the 'KSockReadContinuation' flag OR'd into the flags field. Remaining octets are discarded upon the next read without the KSockReadContinuation flag set.

Recv() should only be used with connected sockets.

A socket may only have one receive operation outstanding at any one time.

If a protocol's information flag is marked with KSIPeekData, then KSockReadPeek may be provided as a flag to Recv(). All other flags are protocol specific.

Receives data from a remote host through a (possibly) unconnected socket and returns a source address.

Flags are provided to add protocol specific information.

A socket may only have one receive operation outstanding at any one time.

Receives data from a remote host through a (possibly) unconnected socket where a source address is returned.

Flags are provided to add protocol specific information.

A socket may only have one receive operation outstanding at any one time.

Receives data from a remote host and completes when data is available.

The function reads at least one byte of data, but will complete as soon as any data is available. The amount of data received is returned via the TSockXfrLength argument.

RecvOneOrMore() can only be used with stream-interfaced connected sockets; datagram interface sockets will return KErrNotSupported.

A socket may only have one receive operation outstanding at any one time.

Receives data from a remote host and completes when data is available.

The function reads at least one byte of data, but will complete as soon as any data is available. The amount of data received is returned via the TSockXfrLength argument.

RecvOneOrMore() can only be used with stream-interfaced connected sockets; datagram interface sockets will return KErrNotSupported.

A socket may only have one receive operation outstanding at any one time.

Gets the remote name of a connected socket.

The remote name of a socket is associated with the remote host a socket is connected to. The remote name is only valid for a connected socket. A socket is either connected through calling Connect() or Accept().

Sends data to a remote host on a connected socket with options set by protocol specific flags.

A socket may only have one send operation in progress at any one time. Send() should only be used with connected sockets.

If a protocol's information flag is marked with KSIUrgentData, then KSockWriteUrgent may be provided as a flag to Send(). All other flags are protocol specific.

Sends data to a remote host on a connected socket with options set by protocol specific flags.

The length of the descriptor indicates the amount of data to be sent. The TSockXfrLength argument will return the amount of data actually sent.

A socket may only have one send operation in progress at any one time.

Send() should only be used with connected sockets.

If a protocol's information flag is marked with KSIUrgentData, then KSockWriteUrgent may be provided as a flag to Send(). All other flags are protocol specific.

Sends data to a remote host through a (possibly) unconnected socket to a specified destination address.

Flags are provided to add protocol specific information. The length of the descriptor indicates the amount of data to be sent. A socket may only have one send operation in progress at any one time.

Sends data to a remote host through a (possibly) unconnected socket to a specified destination address.

Flags are provided to add protocol specific information. The length of the descriptor indicates the amount of data to be sent. A socket may only have one send operation in progress at any one time. The TSockXfrLength argument will return the amount of data sent.

Sets the local port of a socket. Setting the local port is equivalent to calling Bind() with only the port set in the address.

Sets a socket option. The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be set with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Sets a socket option. The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be set with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Shuts down a connected socket - asynchronous.

This method is asynchronous as non emergency shutdown may take a while.

The shut down method allows input and output to be individually stopped for a protocol endpoint. For protocols which support data-in disconnect message, additional arguments are provided.

Shutdown() can be used for protocols which do not have the KSIConnectionLess flag in their protocol information.

To use data in disconnection a protocol must have the flag KSIDisconnectData in its protocol information.

There is no way to cancel a socket shutdown once it has started.

Shuts down a connected socket with disconnect data - asynchronous.

This method is asynchronous as non emergency shutdown may take a while.

The shut down method allows input and output to be individually stopped for a protocol endpoint. For protocols which support data-in disconnect message, additional arguments are provided.

Shutdown() can be used for protocols which do not have the KSIConnectionLess flag in their protocol information.

To use data in disconnection a protocol must have the flag KSIConnectData in its protocol information.

There is no way to cancel a socket shutdown once it has started.

Transfers a socket from one socket server session to another. It creates the socket in the target session, and removes the socket from the source session. The call is made on an uninitialised RSocket object. The socket system name is used to identify the socket to transfer.

If the call fails, the socket that is being transferred remains with the original session. Success or failure can be checked on the originating socket by calling Info(), which returns KErrNone if the transfer failed, and KErrBadHandle if it succeeded.

Platsec considerations require that the source socket must set itself transferable before any attempt to transfer the socket to the destination socket. This is done using a setopt in the following way

		_LIT_SECURITY_POLICY_Cn(KProcPolicy, cap1,cap2,...capn);
		ret = destsock.SetOpt(KSOEnableTransfer, KSOLSocket, KProcPolicy().Package());

where cap1,cap2...capn are the capabilities that the destination process MUST have in order to affect the transfer.

An example is:

		_LIT_SECURITY_POLICY_C2(KProcPolicy, ECapabilityNetworkServices, ECapabilityNetworkControl);
		ret = destsock.SetOpt(KSOEnableTransfer, KSOLSocket, KProcPolicy().Package());

If the setOpt is not set or the destination process does not have sufficient capabilities then the function will return KErrPermissionDenied

Sends data to a remote host.

Write() should only be used with connected sockets.