Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <ES_SOCK.H>

Typedef TNifProgressBuf

typedef TPckgBuf<TNifProgress> TNifProgressBuf;

Description

Buffer for Network Interface Progress

[Top]


Typedef TProtocolName

typedef TBuf<0x20> TProtocolName;

Description

Contains the name of a protocol in structure TProtocolDescTProtocolDesc.

[Top]


Typedef TServiceName

typedef TBuf<0x20> TServiceName;

Description

Defines a descriptor to hold a service name string.

[Top]


Typedef THostName

typedef TBuf<0x100> THostName;

Description

Defines a descriptor to hold a host name string.

[Top]


Typedef TSockXfrLength

typedef TPckgBuf<TInt> TSockXfrLength;

Description

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

[Top]


Typedef TNameEntry

typedef TPckgBuf<TNameRecord> TNameEntry;

Description

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

[Top]


Typedef TPortNum

typedef TPckgBuf<TInt> TPortNum;

Description

Port number on service

[Top]


Enum TByteOrder

TByteOrder

Description

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

EBigEndian

Big endian

ELittleEndian

Little endian

EOtherByteOrder

Other byte order


ES_SOCK.H Global variables

[Top]


SOCKET_SERVER_MAIN_MODULE_NAME

const TLitC8< sizeof("ESock_Main") SOCKET_SERVER_MAIN_MODULE_NAME)={sizeof( "ESock_Main" )-1, "ESock_Main" };

Description

Canonical names for the core ESOCKSVR modules

[Top]


SOCKET_SERVER_IP_MODULE_NAME

const TLitC8< sizeof("ESock_IP") SOCKET_SERVER_IP_MODULE_NAME)={sizeof( "ESock_IP" )-1, "ESock_IP" };

Description

[Top]


SOCKET_SERVER_BT_MODULE_NAME

const TLitC8< sizeof("ESock_Bt") SOCKET_SERVER_BT_MODULE_NAME)={sizeof( "ESock_Bt" )-1, "ESock_Bt" };

Description

[Top]


SOCKET_SERVER_IR_MODULE_NAME

const TLitC8< sizeof("ESock_Ir") SOCKET_SERVER_IR_MODULE_NAME)={sizeof( "ESock_Ir" )-1, "ESock_Ir" };

Description

[Top]


SOCKET_SERVER_SMSWAP_MODULE_NAME

const TLitC8< sizeof("ESock_SmsWap") SOCKET_SERVER_SMSWAP_MODULE_NAME)={sizeof( "ESock_SmsWap" )-1, "ESock_SmsWap" };

Description

[Top]


KESockDefaultMessageSlots

const TUint KESockDefaultMessageSlots=8;

Description

Default number of message slots.

[Top]


KUseEmbeddedUniqueId

const TUint KUseEmbeddedUniqueId=0;

Description

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

[Top]


KConnProgressDefault

const TUint KConnProgressDefault=0;

Description

Default Connection Progress.

[Top]


KMaxSockAddrSize

const TUint KMaxSockAddrSize=0x20;

Description

Maximum sockets address size.

[Top]


KAFUnspec

const TUint KAFUnspec=0;

Description

Default (unspecified) protocol module.

[Top]


KSockStream

const TUint KSockStream=1;

Description

Stream socket.

[Top]


KSockDatagram

const TUint KSockDatagram=2;

Description

Datagram socket.

[Top]


KSockSeqPacket

const TUint KSockSeqPacket=3;

Description

Datagrams with sequence numbers.

[Top]


KSockRaw

const TUint KSockRaw=4;

Description

Raw socket.

[Top]


KSOLSocket

const TInt KSOLSocket=1;

Description

Generic socket options/commands.

[Top]


KLevelUnspecified

const TInt KLevelUnspecified=0;

Description

Unspecified level.

[Top]


KSODebug

const TUint KSODebug=1;

Description

Debugging enabled or disabled . Values are:

(TInt)0. Disabled

(TInt)1. Enabled

[Top]


KSORecvBuf

const TUint KSORecvBuf=2;

Description

Socket receive buffer size. Values are:

KSocketBufSizeUndefined

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

[Top]


KSOSendBuf

const TUint KSOSendBuf=3;

Description

Socket send buffer size. Values are:

KSocketBufSizeUndefined

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

[Top]


KSONonBlockingIO

const TUint KSONonBlockingIO=4;

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=5;

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=6;

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=7;

Description

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

[Top]


KSOUrgentDataOffset

const TUint KSOUrgentDataOffset=8;

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=9;

Description

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

[Top]


KSOEnableTransfer

const TUint KSOEnableTransfer=10;

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(RSocketServ &,const TDesC &) call must be enabled by setting this option.

[Top]


KSODisableTransfer

const TUint KSODisableTransfer=11;

Description

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

[Top]


KSocketBufSizeUndefined

const TInt KSocketBufSizeUndefined=0;

Description

Use default buffer size.

[Top]


KSocketDefaultBufferSize

const TInt KSocketDefaultBufferSize=4096;

Description

Default buffer size.

[Top]


KSocketInternalOptionBit

const TUint KSocketInternalOptionBit=0x80000000;

Description

Must not be set for client requests.

[Top]


KIOctlSelect

const TUint KIOctlSelect=1;

Description

The aDesc parameter of RSocket::Ioctl(TUint,TRequestStatus &,TDes8 *,TUint) 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(TUint,TRequestStatus &,TDes8 *,TUint), with aLevel set to KSOLSocket.

See also:

[Top]


KSockSelectRead

const TUint KSockSelectRead=0x00000001;

Description

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

[Top]


KSockSelectWrite

const TUint KSockSelectWrite=0x00000002;

Description

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

[Top]


KSockSelectExcept

const TUint KSockSelectExcept=0x00000004;

Description

An error has occurred.

[Top]


KSockSelectReadContinuation

const TUint KSockSelectReadContinuation=0x01000000;

Description

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

[Top]


KSockWriteUrgent

const TUint KSockWriteUrgent=0x00000001;

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=0x80000000;

Description

Must not be set for client requests.

[Top]


KSockWriteSystemMask

const TUint KSockWriteSystemMask=0xFF000000;

Description

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

[Top]


KSockReadPeek

const TUint KSockReadPeek=0x00000001;

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=0x80000000;

Description

Must not be set for client requests.

[Top]


KSockReadContinuation

const TUint KSockReadContinuation=0x01000000;

Description

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

[Top]


KSIReliable

const TUint KSIReliable=0x00000002;

Description

The protocol is reliable.

[Top]


KSIInOrder

const TUint KSIInOrder=0x00000004;

Description

The protocol guarantees in-order delivery.

[Top]


KSIMessageBased

const TUint KSIMessageBased=0x00000008;

Description

The protocol is message based.

[Top]


KSIDatagram

const TUint KSIDatagram=KSIMessageBased;

Description

The same as message based.

[Top]


KSIStreamBased

const TUint KSIStreamBased=0x00000010;

Description

The protocol is stream based.

[Top]


KSIPseudoStream

const TUint KSIPseudoStream=0x00000020;

Description

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

[Top]


KSIUrgentData

const TUint KSIUrgentData=0x00000040;

Description

The protocol offers an expedited data service.

[Top]


KSIConnectData

const TUint KSIConnectData=0x00000080;

Description

The protocol can send user data on a connection request.

[Top]


KSIDisconnectData

const TUint KSIDisconnectData=0x00000100;

Description

The protocol can send user data on a disconnect request.

[Top]


KSIBroadcast

const TUint KSIBroadcast=0x00000200;

Description

The protocol supports broadcast addresses.

[Top]


KSIMultiPoint

const TUint KSIMultiPoint=0x00000400;

Description

The protocol supports point to multi-point connections.

[Top]


KSIQOS

const TUint KSIQOS=0x00000800;

Description

The protocol supports a quality of service metric.

[Top]


KSIWriteOnly

const TUint KSIWriteOnly=0x00001000;

Description

The protocol is write only.

[Top]


KSIReadOnly

const TUint KSIReadOnly=0x00002000;

Description

The protocol is read only.

[Top]


KSIGracefulClose

const TUint KSIGracefulClose=0x00004000;

Description

The protocol supports graceful close.

[Top]


KSICanReconnect

const TUint KSICanReconnect=0x00008000;

Description

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

[Top]


KSIPeekData

const TUint KSIPeekData=0x00010000;

Description

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

[Top]


KSIRequiresOwnerInfo

const TUint KSIRequiresOwnerInfo=0x00020000;

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.

[Top]


KNSHierarchicalNaming

const TUint KNSHierarchicalNaming=0x00000002;

Description

Network naming is hierarchical.

[Top]


KNSHeirarchicalNaming

Interface status: deprecated Use KNSHierarchicalNaming instead.

const TUint KNSHeirarchicalNaming=0x00000002;

Description

[Top]


KNSRemoteDiscovery

const TUint KNSRemoteDiscovery=0x00000004;

Description

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

[Top]


KNSServiceResolution

const TUint KNSServiceResolution=0x00000008;

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=0x00000010;

Description

Protocol supports additions to the name database.

[Top]


KNSServiceRegistration

const TUint KNSServiceRegistration=0x00000020;

Description

Protocol supports additions to the service database.

[Top]


KNSDynamicAddressing

const TUint KNSDynamicAddressing=0x00000040;

Description

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

[Top]


KNSInfoDatabase

const TUint KNSInfoDatabase=0x00000080;

Description

Protocol has another database which is defined by the protocol.

[Top]


KNSRequiresConnectionStartup

const TUint KNSRequiresConnectionStartup=0x00000100;

Description

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

[Top]


KSocketNoSecurity

const TUint KSocketNoSecurity=0x00000000;

Description

No security

[Top]


KSecureSockets

const TUint KSecureSockets=0x00000001;

Description

Secure Sockets Layer.

[Top]


KSocketMessageSizeIsStream

const TInt KSocketMessageSizeIsStream=0;

Description

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

[Top]


KSocketMessageSizeUndefined

const TInt KSocketMessageSizeUndefined=1;

Description

Depends on lower layer or is dynamic.

[Top]


KSocketMessageSizeNoLimit

const TInt KSocketMessageSizeNoLimit=-1;

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=0xFFFFFFFF;

Description

Undefined socket type.

[Top]


KUndefinedProtocol

const TUint KUndefinedProtocol=0xFFFFFFFE;

Description

Undefined socket type. Undefined Protocol

[Top]


KErrWouldBlock

const TInt KErrWouldBlock=-1000;

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=-17210;

Description

socket errors

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

[Top]


KErrCannotFindProtocol

const TInt KErrCannotFindProtocol=-17211;

Description

[Top]


KCOLProvider

const TUint KCOLProvider=2;

Description

[Top]


KConnInternalOptionBit

const TUint KConnInternalOptionBit=0x80000000;

Description

[Top]


KConnWriteUserDataBit

const TUint KConnWriteUserDataBit=0x40000000;

Description

[Top]


KConnReadUserDataBit

const TUint KConnReadUserDataBit=0x20000000;

Description

[Top]


KConnectionTypeDefault

const TUint KConnectionTypeDefault=0x0800;

Description

Default connection type

[Top]


KSubConnParamsInterfaceUid

const TInt32 KSubConnParamsInterfaceUid=0x10204303;

Description

[Top]


KSubConnEventInterfaceUid

const TInt32 KSubConnEventInterfaceUid=0x10204305;

Description

[Top]


KSubConnGenericParamsImplUid

const TInt32 KSubConnGenericParamsImplUid=0x10204304;

Description

[Top]


KSubConnGenericEventsImplUid

const TInt32 KSubConnGenericEventsImplUid=0x10204306;

Description

[Top]


KSubConGlobalFamily

const TUint32 KSubConGlobalFamily=0;

Description

[Top]


KSubConQoSFamily

const TUint32 KSubConQoSFamily=1;

Description

[Top]


KSubConAuthorisationFamily

const TUint32 KSubConAuthorisationFamily=2;

Description

[Top]


KSubConnCallDescrParamsFamily

const TUint32 KSubConnCallDescrParamsFamily=3;

Description

[Top]


KSubConnContextDescrParamsFamily

const TUint32 KSubConnContextDescrParamsFamily=4;

Description

[Top]


KNotificationEventMaxSize

const TInt KNotificationEventMaxSize=2048;

Description