ES_SOCK.H Global variables

const TLitC8< sizeof("ESock_Main") SOCKET_SERVER_MAIN_MODULE_NAME;

Description

Canonical names for the core ESOCKSVR modules

const TLitC8< sizeof("ESock_IP") SOCKET_SERVER_IP_MODULE_NAME;

Description

const TLitC8< sizeof("ESock_Bt") SOCKET_SERVER_BT_MODULE_NAME;

Description

const TLitC8< sizeof("ESock_Ir") SOCKET_SERVER_IR_MODULE_NAME;

Description

const TLitC8< sizeof("ESock_SmsWap") SOCKET_SERVER_SMSWAP_MODULE_NAME;

Description

const TUint KESockDefaultMessageSlots;

Description

Default number of message slots.

const TUint KUseEmbeddedUniqueId;

Description

Used by RConnection to identify cases where the subconnection id is embedded in the data structure.

const TUint KConnProgressDefault;

Description

Default Connection Progress.

const TUint KMaxSockAddrSize;

Description

Maximum sockets address size.

const TUint KAFUnspec;

Description

Default (unspecified) protocol module.

const TUint KSockStream;

Description

Stream socket.

const TUint KSockDatagram;

Description

Datagram socket.

const TUint KSockSeqPacket;

Description

Datagrams with sequence numbers.

const TUint KSockRaw;

Description

Raw socket.

const TInt KSOLSocket;

Description

Generic socket options/commands.

const TInt KLevelUnspecified;

Description

Unspecified level.

const TUint KSODebug;

Description

Debugging enabled or disabled . Values are:

(TInt)0. Disabled

(TInt)1. Enabled

const TUint KSORecvBuf;

Description

Socket receive buffer size. Values are:

KSocketBufSizeUndefined

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

const TUint KSOSendBuf;

Description

Socket send buffer size. Values are:

KSocketBufSizeUndefined

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

const TUint KSONonBlockingIO;

Description

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

(TInt)0. Disabled

(TInt)1. Enabled

const TUint KSOBlockingIO;

Description

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

(TInt)0. Disabled

(TInt)1. Enabled

const TUint KSOSelectPoll;

Description

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.

const TUint KSOReadBytesPending;

Description

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

const TUint KSOUrgentDataOffset;

Description

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

const TUint KSOSelectLastError;

Description

Getting only: retrieves the last error. Value is a TInt.

const TUint KSOEnableTransfer;

Description

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.

const TUint KSODisableTransfer;

Description

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

const TInt KSocketBufSizeUndefined;

Description

Use default buffer size.

const TInt KSocketDefaultBufferSize;

Description

Default buffer size.

const TUint KSocketInternalOptionBit;

Description

Must not be set for client requests.

const TUint KIOctlSelect;

Description

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.

const TUint KSockSelectRead;

Description

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

const TUint KSockSelectWrite;

Description

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

const TUint KSockSelectExcept;

Description

An error has occurred.

const TUint KSockSelectReadContinuation;

Description

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

const TUint KSockWriteUrgent;

Description

Socket write flags

const TUint KSocketInternalWriteBit;

Description

const TUint KSockWriteSystemMask;

Description

const TUint KSockReadPeek;

Description

const TUint KSocketInternalReadBit;

Description

const TUint KSockReadContinuation;

Description

const TUint KSIReliable;

Description

The protocol is reliable.

const TUint KSIInOrder;

Description

The protocol guarantees in-order delivery.

const TUint KSIMessageBased;

Description

The protocol is message based.

const TUint KSIDatagram;

Description

The same as message based.

const TUint KSIStreamBased;

Description

The protocol is stream based.

const TUint KSIPseudoStream;

Description

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

const TUint KSIUrgentData;

Description

The protocol offers an expedited data service.

const TUint KSIConnectData;

Description

The protocol can send user data on a connection request.

const TUint KSIDisconnectData;

Description

The protocol can send user data on a disconnect request.

const TUint KSIBroadcast;

Description

The protocol supports broadcast addresses.

const TUint KSIMultiPoint;

Description

The protocol supports point to multi-point connections.

const TUint KSIQOS;

Description

The protocol supports a quality of service metric.

const TUint KSIWriteOnly;

Description

The protocol is write only.

const TUint KSIReadOnly;

Description

The protocol is read only.

const TUint KSIGracefulClose;

Description

The protocol supports graceful close.

const TUint KSICanReconnect;

Description

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

const TUint KSIPeekData;

Description

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

const TUint KSIRequiresOwnerInfo;

Description

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.

See also:

• KSoOwnerInfo
• and
• TSoOwnerInfo

const TUint KNSHeirarchicalNaming;

Description

Network naming is hierarchical.

const TUint KNSRemoteDiscovery;

Description

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

const TUint KNSServiceResolution;

Description

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

const TUint KNSNameRegistration;

Description

Protocol supports additions to the name database.

const TUint KNSServiceRegistration;

Description

Protocol supports additions to the service database.

const TUint KNSDynamicAddressing;

Description

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

const TUint KNSInfoDatabase;

Description

Protocol has another database which is defined by the protocol.

const TUint KNSRequiresConnectionStartup;

Description

Protocol may request Socket Server to startup a connection on its behalf (via the KErrCompletion error code)

const TUint KSocketNoSecurity;

Description

No security

const TUint KSecureSockets;

Description

Secure Sockets Layer.

See also:

• CSecureSocket

const TInt KSocketMessageSizeIsStream;

Description

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

const TInt KSocketMessageSizeUndefined;

Description

Depends on lower layer or is dynamic.

const TInt KSocketMessageSizeNoLimit;

Description

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

const TUint KUndefinedSockType;

Description

Undefined socket type.

const TUint KUndefinedProtocol;

Description

Undefined socket type. Undefined Protocol

const TInt KErrWouldBlock;

Description

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.

const TInt KErrConnectionTerminated;

Description

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.

const TInt KErrCannotFindProtocol;

Description

const TUint KCOLProvider;

Description

const TUint KConnInternalOptionBit;

Description

const TUint KConnWriteUserDataBit;

Description

const TUint KConnReadUserDataBit;

Description

const TUint KConnectionTypeDefault;

Description

Default connection type

const TInt32 KSubConnParamsInterfaceUid;

Description

const TInt32 KSubConnEventInterfaceUid;

Description

const TInt32 KSubConnGenericParamsImplUid;

Description

const TInt32 KSubConnGenericEventsImplUid;

Description

const TUint32 KSubConGlobalFamily;

Description

const TUint32 KSubConQoSFamily;

Description

const TUint32 KSubConAuthorisationFamily;

Description

const TUint32 KSubConnCallDescrParamsFamily;

Description

const TInt KNotificationEventMaxSize;

Description