es_sock.h File Reference

SOCKET_SERVER_MAIN_MODULE_NAME

const TLitC8< sizeof("ESock_Main")>SOCKET_SERVER_MAIN_MODULE_NAME[static]

Canonical names for the core ESOCKSVR modules

SOCKET_SERVER_IP_MODULE_NAME

const TLitC8< sizeof("ESock_IP")>SOCKET_SERVER_IP_MODULE_NAME[static]

SOCKET_SERVER_BT_MODULE_NAME

const TLitC8< sizeof("ESock_Bt")>SOCKET_SERVER_BT_MODULE_NAME[static]

SOCKET_SERVER_IR_MODULE_NAME

const TLitC8< sizeof("ESock_Ir")>SOCKET_SERVER_IR_MODULE_NAME[static]

SOCKET_SERVER_SMSWAP_MODULE_NAME

const TLitC8< sizeof("ESock_SmsWap")>SOCKET_SERVER_SMSWAP_MODULE_NAME[static]

KConnectionUp

const TUintKConnectionUp

Progress Notification to inform clients Connection is up This event has the same numerical values as KLinkLayerOpen which is deprecated

KConnectionDown

const TUintKConnectionDown

Progress Notification to inform clients Connection is up This event has the same numerical values as KLinkLayerClosed which is deprecated

KESockDefaultMessageSlots

const TUintKESockDefaultMessageSlots

Default number of message slots.

KMaxSubConnectionEventSize

const TUintKMaxSubConnectionEventSize

Size of Maximum SubConnection event

Note:

If you allocate this on the heap, remember to delete through the pointer to the buffer and not any pointers to the events held inside it if you change this value, you will alter the function signature and break the .def file

Typedef TSubConnectionUniqueId

typedef TUint TSubConnectionUniqueId

SubConnection Unique Id

THIS API IS TO BE DEPRECATED

Typedef TSubConnectionNotificationBuf

typedef TBuf8< KMaxSubConnectionEventSize >TSubConnectionNotificationBuf

Buffer for notification of any change in the state of SubConnection.

THIS API IS TO BE DEPRECATED

KUseEmbeddedUniqueId

const TUintKUseEmbeddedUniqueId

KConnProgressDefault

const TUintKConnProgressDefault

Typedef TNifProgressBuf

typedef TPckgBuf< TNifProgress >TNifProgressBuf

Buffer for Network Interface Progress

KMaxSockAddrSize

const TUintKMaxSockAddrSize

Maximum sockets address size.

KAFUnspec

const TUintKAFUnspec

Default (unspecified) protocol module.

KSockStream

const TUintKSockStream

Stream socket.

KSockDatagram

const TUintKSockDatagram

Datagram socket.

KSockSeqPacket

const TUintKSockSeqPacket

Datagrams with sequence numbers.

KSockRaw

const TUintKSockRaw

Raw socket.

KSOLSocket

const TIntKSOLSocket

Generic socket options/commands.

KLevelUnspecified

const TIntKLevelUnspecified

Unspecified level.

KSODebug

const TUintKSODebug

Debugging enabled or disabled . Values are:

(TInt)0. Disabled

(TInt)1. Enabled

KSORecvBuf

const TUintKSORecvBuf

Socket receive buffer size. Values are:

KSocketBufSizeUndefined

1 to KMaxTUint: explicit buffer size, supplied as a TPckgBuf<TUint>

KSOSendBuf

const TUintKSOSendBuf

Socket send buffer size. Values are:

KSocketBufSizeUndefined

1 to KMaxTUint: explicit buffer size, supplied as a TPckgBuf<TUint>

KSONonBlockingIO

const TUintKSONonBlockingIO

Socket nonblocking mode. To set, no option values are required. For getting, values are:

(TInt)0. Disabled

(TInt)1. Enabled

KSOBlockingIO

const TUintKSOBlockingIO

Socket blocking mode. To set, no values are required. For getting, values are:

(TInt)0. Disabled

(TInt)1. Enabled

KSOSelectPoll

const TUintKSOSelectPoll

Getting only: gets a bitmask of flags describing the read/write/exception status of the socket. Value is a TInt containing a bitmask of socket status (KSockSelectExcept etc.) constants.

KSOReadBytesPending

const TUintKSOReadBytesPending

Getting only: retrieve the number of bytes currently available for reading. Value is a TInt.

KSOUrgentDataOffset

const TUintKSOUrgentDataOffset

Getting only: retrieve the urgent data offset (only for stream protocols that support urgent data). Value is a TInt.

KSOSelectLastError

const TUintKSOSelectLastError

Getting only: retrieves the last error. Errors are normally reported by the called method and behaviour is protocol dependent. KSOSelectLastError does not return such errors. Value is a TInt.

KSOEnableTransfer

const TUintKSOEnableTransfer

Setting only. Enables socket to be transferred to the process with given capabilities. The capabilities set should be supplied as TPckgBuf<TSecurityPolicy>. Each RSocket::Transfer() call must be enabled by setting this option.

KSODisableTransfer

const TUintKSODisableTransfer

Setting only. Disables a socket's possibility to be transferred. No option required.

KSOTcpRstTermination

const TUintKSOTcpRstTermination

Getting only. Indicates if the TCP connection or its establishment was terminated with a RST from the network peer. Values are: (TInt)0. Termination was not caused by TCP RST (TInt)non-zero. Termination was caused by TCP RST

KSocketBufSizeUndefined

const TIntKSocketBufSizeUndefined

Use default buffer size.

KSocketDefaultBufferSize

const TIntKSocketDefaultBufferSize

Default buffer size.

KSocketInternalOptionBit

const TUintKSocketInternalOptionBit

KIOctlSelect

const TUintKIOctlSelect

The aDesc parameter of RSocket::Ioctl() specifies a TUint containing a bitmask of Socket status constants. The completion status will be the subset of those conditions which is now true for the socket.

Used through RSocket::Ioctl(), with aLevel set to KSOLSocket.

See also: KSOSelectPoll parameter to RSocket::GetOpt(), which allows the current select state of the socket to be read synchronously, and KSOSelectLastError, which returns the error code.

KSockSelectRead

const TUintKSockSelectRead

Data is available to be read; for listening sockets, a connect is pending.

KSockSelectWrite

const TUintKSockSelectWrite

Writing to the socket is not currently blocked by flow-control.

KSockSelectExcept

const TUintKSockSelectExcept

An error has occurred.

KSockSelectReadContinuation

const TUintKSockSelectReadContinuation

Include tail of prior read datagram as available data (ie indicates next read will be with read continuation)

KSockWriteUrgent

const TUintKSockWriteUrgent

The data to be sent is urgent and is given a higher priority than ordinary data in the send queue. KSockWriteUrgent may only be provided as a flag to Send() if the protocol's information flag is marked with KSIUrgentData, otherwise Send() will return with KErrNotSupported. AKA: Out of band or unit data.

KSocketInternalWriteBit

const TUintKSocketInternalWriteBit

Must not be set for client requests.

KSockWriteSystemMask

const TUintKSockWriteSystemMask

The top 8 bits are reserved for system purposes; protocols must not define these bits.

KSockReadPeek

const TUintKSockReadPeek

Read data without consuming it, data remains in the receive queue. KSockReadPeek may only be provided as a flag to Recv() if the protocol's information flag is marked with KSIPeekData, otherwise Recv() will return with KErrNotSupported.

KSocketInternalReadBit

const TUintKSocketInternalReadBit

Must not be set for client requests.

KSockReadContinuation

const TUintKSockReadContinuation

Read from datagram in a stream-like fashion (not discarding tails).

Enum TByteOrder

Used in structure TProtocolDesc to describes the endianness of a protocol.

EnumeratorValueDescription
EBigEndian

Big endian

ELittleEndian

Little endian

EOtherByteOrder

Other byte order

KSIConnectionLess

const TUintKSIConnectionLess

The protocol is connectionless.

KSIReliable

const TUintKSIReliable

The protocol is reliable.

KSIInOrder

const TUintKSIInOrder

The protocol guarantees in-order delivery.

KSIMessageBased

const TUintKSIMessageBased

The protocol is message based.

KSIDatagram

const TUintKSIDatagram

The same as message based.

KSIStreamBased

const TUintKSIStreamBased

The protocol is stream based.

KSIPseudoStream

const TUintKSIPseudoStream

The protocol supports a stream like interface but maintains datagram boundaries.

KSIUrgentData

const TUintKSIUrgentData

The protocol offers an expedited data service.

KSIConnectData

const TUintKSIConnectData

The protocol can send user data on a connection request.

KSIDisconnectData

const TUintKSIDisconnectData

The protocol can send user data on a disconnect request.

KSIBroadcast

const TUintKSIBroadcast

The protocol supports broadcast addresses.

KSIMultiPoint

const TUintKSIMultiPoint

The protocol supports point to multi-point connections.

KSIQOS

const TUintKSIQOS

The protocol supports a quality of service metric.

KSIWriteOnly

const TUintKSIWriteOnly

The protocol is write only.

KSIReadOnly

const TUintKSIReadOnly

The protocol is read only.

KSIGracefulClose

const TUintKSIGracefulClose

The protocol supports graceful close.

KSICanReconnect

const TUintKSICanReconnect

The same socket can be reconnected if it disconnects (for whatever reason).

KSIPeekData

const TUintKSIPeekData

Protocol supports peeking (looking at the data without removing it from the protocol).

KSIRequiresOwnerInfo

const TUintKSIRequiresOwnerInfo

Protocol is to be informed of the identity of the client (i.e. process ID, thread ID and UID) of each SAP (i.e. Socket Service Provider) created. Note that this value has no meaningful interpretation on the client side.

See also: KSoOwnerInfo and TSoOwnerInfo

KSIReserved

const TUintKSIReserved

KNSNameResolution

const TUintKNSNameResolution

Protocol supports resolving human readable entity names into network addresses (like DNS).

KNSHierarchicalNaming

const TUintKNSHierarchicalNaming

Network naming is hierarchical.

KNSHeirarchicalNaming

const TUintKNSHeirarchicalNaming

DeprecatedUse KNSHierarchicalNaming instead.

KNSRemoteDiscovery

const TUintKNSRemoteDiscovery

Addressing is dynamic and should be attempted every time before connecting (like IrDA).

KNSServiceResolution

const TUintKNSServiceResolution

Protocol supports service name to port number resolution. (For example, you can look up TCP to get port 48.)

KNSNameRegistration

const TUintKNSNameRegistration

Protocol supports additions to the name database.

KNSServiceRegistration

const TUintKNSServiceRegistration

Protocol supports additions to the service database.

KNSDynamicAddressing

const TUintKNSDynamicAddressing

Addressing is dynamic - i.e. name to address mapping may change (like IrDA which randomly chooses machine addresses.)

KNSInfoDatabase

const TUintKNSInfoDatabase

Protocol has another database which is defined by the protocol.

KNSRequiresConnectionStartup

const TUintKNSRequiresConnectionStartup

Protocol may request Socket Server to startup a connection on its behalf (via the KErrCompletion error code) Note that this value has no meaningful interpretation on the client side.

KNSReserved

const TUintKNSReserved

KSocketNoSecurity

const TUintKSocketNoSecurity

No security

KSecureSockets

const TUintKSecureSockets

Secure Sockets Layer.

See also: CSecureSocket

KSocketMessageSizeIsStream

const TIntKSocketMessageSizeIsStream

Reads and writes can be of any size: the data is treated as a stream.

KSocketMessageSizeUndefined

const TIntKSocketMessageSizeUndefined

Depends on lower layer or is dynamic.

KSocketMessageSizeNoLimit

const TIntKSocketMessageSizeNoLimit

Data is packet-oriented but packets can be of any size (i.e. the remote end must specify a Read of the same size as your Write, but there is no limit on this size.)

KUndefinedSockType

const TUintKUndefinedSockType

Undefined socket type.

KUndefinedProtocol

const TUintKUndefinedProtocol

Undefined socket type. Undefined Protocol

KUndefinedAddressFamily

const TUintKUndefinedAddressFamily

Undefined address family

Typedef TProtocolName

typedef TBuf< 0x20 >TProtocolName

Contains the name of a protocol in structure TProtocolDesc.

Typedef TServiceName

typedef TBuf< 0x20 >TServiceName

Defines a descriptor to hold a service name string.

Typedef THostName

typedef TBuf< 0x100 >THostName

Defines a descriptor to hold a host name string.

KErrWouldBlock

const TIntKErrWouldBlock

This error is returned from operations on non-blocking sockets that cannot be completed immediately, for example receive when no data is queued for reading. It is a non-fatal error, and the operation should be retried later.

KErrConnectionTerminated

const TIntKErrConnectionTerminated

socket errors

The value -17210 is taken from the range allocated for Esock (beginning at -17200) A gap has been left between the currently existing vals and this one.

KErrCannotFindProtocol

const TIntKErrCannotFindProtocol

KErrTierNotFound

const TIntKErrTierNotFound

KErrConnectionContention

const TIntKErrConnectionContention

KErrProtocolNotReady

const TIntKErrProtocolNotReady

The protocol requested for the socket was recognised but was not able to be used. This can happen with protocols that require specific settings to have been prepared prior to the socket being opened.

Typedef TSockXfrLength

typedef TPckgBuf< TInt >TSockXfrLength

Used in RSocket read and write calls to pass the length of data read and written.

Typedef TNameEntry

typedef TPckgBuf< TNameRecord >TNameEntry

Packages the TNameRecord class so that it can be passed between a client and the socket server.

Typedef TPortNum

typedef TPckgBuf< TInt >TPortNum

Port number on service

KConnectionTypeDefault

const TUintKConnectionTypeDefault

Default connection type

KSubConnParamsInterfaceUid

const TInt32KSubConnParamsInterfaceUid

KSubConnEventInterfaceUid

const TInt32KSubConnEventInterfaceUid

KSubConnGenericParamsImplUid

const TInt32KSubConnGenericParamsImplUid

KSubConnGenericEventsImplUid

const TInt32KSubConnGenericEventsImplUid

KSubConGlobalFamily

const TUint32KSubConGlobalFamily

KSubConQoSFamily

const TUint32KSubConQoSFamily

KSubConAuthorisationFamily

const TUint32KSubConAuthorisationFamily

KSubConnCallDescrParamsFamily

const TUint32KSubConnCallDescrParamsFamily

KSubConnContextDescrParamsFamily

const TUint32KSubConnContextDescrParamsFamily

KSubConIPAddressInfoFamily

const TUint32KSubConIPAddressInfoFamily

KProtocolExtensionFamily

const TInt32KProtocolExtensionFamily

KFlowParametersFamily

const TInt32KFlowParametersFamily

KNotificationEventMaxSize

const TIntKNotificationEventMaxSize