Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: ES_SOCK.H

ES_SOCK.H Global variables


SOCKET_SERVER_MAIN_MODULE_NAME

const TLitC8< sizeof("ESock_Main") SOCKET_SERVER_MAIN_MODULE_NAME;

Description

Canonical names for the core ESOCKSVR modules

[Top]


SOCKET_SERVER_IP_MODULE_NAME

const TLitC8< sizeof("ESock_IP") SOCKET_SERVER_IP_MODULE_NAME;

Description

[Top]


SOCKET_SERVER_BT_MODULE_NAME

const TLitC8< sizeof("ESock_Bt") SOCKET_SERVER_BT_MODULE_NAME;

Description

[Top]


SOCKET_SERVER_IR_MODULE_NAME

const TLitC8< sizeof("ESock_Ir") SOCKET_SERVER_IR_MODULE_NAME;

Description

[Top]


SOCKET_SERVER_SMSWAP_MODULE_NAME

const TLitC8< sizeof("ESock_SmsWap") SOCKET_SERVER_SMSWAP_MODULE_NAME;

Description

[Top]


KESockDefaultMessageSlots

const TUint KESockDefaultMessageSlots;

Description

Default number of message slots.

[Top]


KUseEmbeddedUniqueId

const TUint KUseEmbeddedUniqueId;

Description

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

[Top]


KConnProgressDefault

const TUint KConnProgressDefault;

Description

Default Connection Progress.

[Top]


KMaxSockAddrSize

const TUint KMaxSockAddrSize;

Description

Maximum sockets address size.

[Top]


KAFUnspec

const TUint KAFUnspec;

Description

Default (unspecified) protocol module.

[Top]


KSockStream

const TUint KSockStream;

Description

Stream socket.

[Top]


KSockDatagram

const TUint KSockDatagram;

Description

Datagram socket.

[Top]


KSockSeqPacket

const TUint KSockSeqPacket;

Description

Datagrams with sequence numbers.

[Top]


KSockRaw

const TUint KSockRaw;

Description

Raw socket.

[Top]


KSOLSocket

const TInt KSOLSocket;

Description

Generic socket options/commands.

[Top]


KLevelUnspecified

const TInt KLevelUnspecified;

Description

Unspecified level.

[Top]


KSODebug

const TUint KSODebug;

Description

Debugging enabled or disabled . Values are:

(TInt)0. Disabled

(TInt)1. Enabled

[Top]


KSORecvBuf

const TUint KSORecvBuf;

Description

Socket receive buffer size. Values are:

KSocketBufSizeUndefined

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

[Top]


KSOSendBuf

const TUint KSOSendBuf;

Description

Socket send buffer size. Values are:

KSocketBufSizeUndefined

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

[Top]


KSONonBlockingIO

const TUint KSONonBlockingIO;

Description

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

(TInt)0. Disabled

(TInt)1. Enabled

[Top]


KSOBlockingIO

const TUint KSOBlockingIO;

Description

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

(TInt)0. Disabled

(TInt)1. Enabled

[Top]


KSOSelectPoll

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.

[Top]


KSOReadBytesPending

const TUint KSOReadBytesPending;

Description

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

[Top]


KSOUrgentDataOffset

const TUint KSOUrgentDataOffset;

Description

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

[Top]


KSOSelectLastError

const TUint KSOSelectLastError;

Description

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

[Top]


KSOEnableTransfer

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.

[Top]


KSODisableTransfer

const TUint KSODisableTransfer;

Description

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

[Top]


KSocketBufSizeUndefined

const TInt KSocketBufSizeUndefined;

Description

Use default buffer size.

[Top]


KSocketDefaultBufferSize

const TInt KSocketDefaultBufferSize;

Description

Default buffer size.

[Top]


KSocketInternalOptionBit

const TUint KSocketInternalOptionBit;

Description

Must not be set for client requests.

[Top]


KIOctlSelect

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:

[Top]


KSockSelectRead

const TUint KSockSelectRead;

Description

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

[Top]


KSockSelectWrite

const TUint KSockSelectWrite;

Description

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

[Top]


KSockSelectExcept

const TUint KSockSelectExcept;

Description

An error has occurred.

[Top]


KSockSelectReadContinuation

const TUint KSockSelectReadContinuation;

Description

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

[Top]


KSockWriteUrgent

const TUint KSockWriteUrgent;

Description

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.

[Top]


KSocketInternalWriteBit

const TUint KSocketInternalWriteBit;

Description

Must not be set for client requests.

[Top]


KSockWriteSystemMask

const TUint KSockWriteSystemMask;

Description

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

[Top]


KSockReadPeek

const TUint KSockReadPeek;

Description

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.

[Top]


KSocketInternalReadBit

const TUint KSocketInternalReadBit;

Description

Must not be set for client requests.

[Top]


KSockReadContinuation

const TUint KSockReadContinuation;

Description

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

[Top]


KSIReliable

const TUint KSIReliable;

Description

The protocol is reliable.

[Top]


KSIInOrder

const TUint KSIInOrder;

Description

The protocol guarantees in-order delivery.

[Top]


KSIMessageBased

const TUint KSIMessageBased;

Description

The protocol is message based.

[Top]


KSIDatagram

const TUint KSIDatagram;

Description

The same as message based.

[Top]


KSIStreamBased

const TUint KSIStreamBased;

Description

The protocol is stream based.

[Top]


KSIPseudoStream

const TUint KSIPseudoStream;

Description

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

[Top]


KSIUrgentData

const TUint KSIUrgentData;

Description

The protocol offers an expedited data service.

[Top]


KSIConnectData

const TUint KSIConnectData;

Description

The protocol can send user data on a connection request.

[Top]


KSIDisconnectData

const TUint KSIDisconnectData;

Description

The protocol can send user data on a disconnect request.

[Top]


KSIBroadcast

const TUint KSIBroadcast;

Description

The protocol supports broadcast addresses.

[Top]


KSIMultiPoint

const TUint KSIMultiPoint;

Description

The protocol supports point to multi-point connections.

[Top]


KSIQOS

const TUint KSIQOS;

Description

The protocol supports a quality of service metric.

[Top]


KSIWriteOnly

const TUint KSIWriteOnly;

Description

The protocol is write only.

[Top]


KSIReadOnly

const TUint KSIReadOnly;

Description

The protocol is read only.

[Top]


KSIGracefulClose

const TUint KSIGracefulClose;

Description

The protocol supports graceful close.

[Top]


KSICanReconnect

const TUint KSICanReconnect;

Description

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

[Top]


KSIPeekData

const TUint KSIPeekData;

Description

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

[Top]


KSIRequiresOwnerInfo

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. Note that this value has no meaningful interpretation on the client side.

[Top]


KNSNameResolution

const TUint KNSNameResolution;

Description

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

[Top]


KNSHierarchicalNaming

const TUint KNSHierarchicalNaming;

Description

Network naming is hierarchical.

[Top]


KNSHeirarchicalNaming

const TUint KNSHeirarchicalNaming;

Description

[Top]


KNSRemoteDiscovery

const TUint KNSRemoteDiscovery;

Description

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

[Top]


KNSServiceResolution

const TUint KNSServiceResolution;

Description

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

[Top]


KNSNameRegistration

const TUint KNSNameRegistration;

Description

Protocol supports additions to the name database.

[Top]


KNSServiceRegistration

const TUint KNSServiceRegistration;

Description

Protocol supports additions to the service database.

[Top]


KNSDynamicAddressing

const TUint KNSDynamicAddressing;

Description

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

[Top]


KNSInfoDatabase

const TUint KNSInfoDatabase;

Description

Protocol has another database which is defined by the protocol.

[Top]


KNSRequiresConnectionStartup

const TUint KNSRequiresConnectionStartup;

Description

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.

[Top]


KSocketNoSecurity

const TUint KSocketNoSecurity;

Description

No security

[Top]


KSecureSockets

const TUint KSecureSockets;

Description

Secure Sockets Layer.

[Top]


KSocketMessageSizeIsStream

const TInt KSocketMessageSizeIsStream;

Description

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

[Top]


KSocketMessageSizeUndefined

const TInt KSocketMessageSizeUndefined;

Description

Depends on lower layer or is dynamic.

[Top]


KSocketMessageSizeNoLimit

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

[Top]


KUndefinedSockType

const TUint KUndefinedSockType;

Description

Undefined socket type.

[Top]


KUndefinedProtocol

const TUint KUndefinedProtocol;

Description

Undefined socket type. Undefined Protocol

[Top]


KErrWouldBlock

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.

[Top]


KErrConnectionTerminated

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.

[Top]


KErrCannotFindProtocol

const TInt KErrCannotFindProtocol;

Description

[Top]


KCOLProvider

const TUint KCOLProvider;

Description

[Top]


KConnInternalOptionBit

const TUint KConnInternalOptionBit;

Description

[Top]


KConnWriteUserDataBit

const TUint KConnWriteUserDataBit;

Description

[Top]


KConnReadUserDataBit

const TUint KConnReadUserDataBit;

Description

[Top]


KConnectionTypeDefault

const TUint KConnectionTypeDefault;

Description

Default connection type

[Top]


KSubConnParamsInterfaceUid

const TInt32 KSubConnParamsInterfaceUid;

Description

[Top]


KSubConnEventInterfaceUid

const TInt32 KSubConnEventInterfaceUid;

Description

[Top]


KSubConnGenericParamsImplUid

const TInt32 KSubConnGenericParamsImplUid;

Description

[Top]


KSubConnGenericEventsImplUid

const TInt32 KSubConnGenericEventsImplUid;

Description

[Top]


KSubConGlobalFamily

const TUint32 KSubConGlobalFamily;

Description

[Top]


KSubConQoSFamily

const TUint32 KSubConQoSFamily;

Description

[Top]


KSubConAuthorisationFamily

const TUint32 KSubConAuthorisationFamily;

Description

[Top]


KSubConnCallDescrParamsFamily

const TUint32 KSubConnCallDescrParamsFamily;

Description

[Top]


KSubConnContextDescrParamsFamily

const TUint32 KSubConnContextDescrParamsFamily;

Description

[Top]


KNotificationEventMaxSize

const TInt KNotificationEventMaxSize;

Description