- Generated by
1.9.8
|
Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
|
#include <e32base.h>#include <nifvar.h>#include <comms-infras/metacontainer.h>#include <elements/sd_errors.h>#include <comms-infras/es_parameterset.h>#include <comms-infras/es_event.h>#include <es_sock_internal.h>#include <es_sock_partner.h>#include <es_sock.inl>Go to the source code of this file.
Classes | |
| class | TSessionPref |
| Hint to the Socket Server on what will be the principal usage of the connection. More... | |
| class | TNifProgress |
| Contains progress information on a dial-up connection. More... | |
| class | TNifAgentInfo |
| Contains information describing an agent. More... | |
| struct | SSockAddr |
| Socket address offsets. More... | |
| class | TSockAddr |
| Represents an end point address. More... | |
| struct | TProtocolDesc |
| Socket protocol information for use by clients. More... | |
| class | RSocketServ |
| Provides the Connect() function to create an IPC communication channel to the socket server. More... | |
| class | RSocket |
| Provides a client endpoint to a protocol. More... | |
| class | TNameRecord |
| Contains the results of name queries. More... | |
| class | RHostResolver |
| Provides an interface to host name resolution services, such as DNS, that may be provided by particular protocol modules. More... | |
| class | RServiceResolver |
| Provides an interface to resolver service names and ports. More... | |
| class | RNetDatabase |
| Provides an interface to network databases, such as LM-IAS with IrDA, that may be provided by particular protocol modules. More... | |
| class | RConnection |
| The management interface for a network connection or subconnection. More... | |
| class | CSubConParameterSet |
| Base class for all RSubConnection parameter sets. More... | |
| class | CSubConGenericParameterSet |
| Base class for generic RSubConnection parameter sets. More... | |
| class | CSubConExtensionParameterSet |
| Base class for extended RSubConnection parameter sets. More... | |
| class | CSubConParameterFamily |
| Container of RSubConnection parameter sets. More... | |
| class | RSubConParameterBundle |
| Container for (bundle of) SubConnection parameter families. More... | |
| class | TNotificationEventBuf |
| Buffer for Sub-connection event notiifcation. More... | |
| class | CSubConNotificationEvent |
| class | TSubConnOpen |
| class | RSubConnection |
| A Sub-Connection, a channel within a Connection. More... | |
| struct | RSubConnection::TEventFilter |
| class | ByteOrder |
| Reverses the byte order in 16 and 32-bit values. More... | |
| class | BigEndian |
| Inserts and extracts integers in big-endian format. More... | |
| class | LittleEndian |
| Inserts and extracts integers in little-endian format. More... | |
| class | TAccessPointInfo |
| Stores Access Point information. More... | |
Namespaces | |
| namespace | ESock |
| namespace | ESockDebug |
Typedefs | |
| typedef TUint | TSubConnectionUniqueId |
| SubConnection Unique Id. | |
| typedef TBuf8< KMaxSubConnectionEventSize > | TSubConnectionNotificationBuf |
| Buffer for notification of any change in the state of SubConnection. | |
| typedef TPckgBuf< TNifProgress > | TNifProgressBuf |
| Buffer for Network Interface Progress. | |
| typedef TBuf< 0x20 > | TProtocolName |
| Contains the name of a protocol in structure TProtocolDesc. | |
| typedef TBuf< 0x20 > | TServiceName |
| Defines a descriptor to hold a service name string. | |
| typedef TBuf< 0x100 > | THostName |
| Defines a descriptor to hold a host name string. | |
| typedef TPckgBuf< TInt > | TSockXfrLength |
| Used in RSocket read and write calls to pass the length of data read and written. | |
| typedef TPckgBuf< TNameRecord > | TNameEntry |
| Packages the TNameRecord class so that it can be passed between a client and the socket server. | |
| typedef TPckgBuf< TInt > | TPortNum |
| Port number on service. | |
Enumerations | |
| enum | TByteOrder { EBigEndian , ELittleEndian , EOtherByteOrder } |
| Used in structure TProtocolDesc to describes the endianness of a protocol. More... | |
Functions | |
| _LIT8 (SOCKET_SERVER_MAIN_MODULE_NAME, "ESock_Main") | |
| Canonical names for the core ESOCKSVR modules. | |
| _LIT8 (SOCKET_SERVER_IP_MODULE_NAME, "ESock_IP") | |
| _LIT8 (SOCKET_SERVER_BT_MODULE_NAME, "ESock_Bt") | |
| _LIT8 (SOCKET_SERVER_IR_MODULE_NAME, "ESock_Ir") | |
| _LIT8 (SOCKET_SERVER_SMSWAP_MODULE_NAME, "ESock_SmsWap") | |
Variables | |
| const TUint | KConnectionUp = 7000 |
| Progress Notification to inform clients Connection is up This event has the same numerical values as KLinkLayerOpen which is deprecated. | |
| const TUint | KConnectionDown = 8000 |
| Progress Notification to inform clients Connection is up This event has the same numerical values as KLinkLayerClosed which is deprecated. | |
| const TUint | KESockDefaultMessageSlots =8 |
| Default number of message slots. | |
| const TUint | KMaxSubConnectionEventSize = 512 |
| Size of Maximum SubConnection event. | |
| const TUint | KUseEmbeddedUniqueId = 0 |
| const TUint | KConnProgressDefault = 0 |
| const TUint | KMaxSockAddrSize =0x20 |
| Maximum sockets address size. | |
| const TUint | KAFUnspec =0 |
| Default (unspecified) protocol module. | |
| const TUint | KSockStream =1 |
| Stream socket. | |
| const TUint | KSockDatagram =2 |
| Datagram socket. | |
| const TUint | KSockSeqPacket =3 |
| Datagrams with sequence numbers. | |
| const TUint | KSockRaw =4 |
| Raw socket. | |
| const TInt | KSOLSocket =1 |
| Generic socket options/commands. | |
| const TInt | KLevelUnspecified =0 |
| Unspecified level. | |
| const TUint | KSODebug =1 |
| Debugging enabled or disabled . | |
| const TUint | KSORecvBuf =2 |
| Socket receive buffer size. | |
| const TUint | KSOSendBuf =3 |
| Socket send buffer size. | |
| const TUint | KSONonBlockingIO =4 |
| Socket nonblocking mode. | |
| const TUint | KSOBlockingIO =5 |
| Socket blocking mode. | |
| const TUint | KSOSelectPoll =6 |
| Getting only: gets a bitmask of flags describing the read/write/exception status of the socket. | |
| const TUint | KSOReadBytesPending =7 |
| Getting only: retrieve the number of bytes currently available for reading. | |
| const TUint | KSOUrgentDataOffset =8 |
| Getting only: retrieve the urgent data offset (only for stream protocols that support urgent data). | |
| const TUint | KSOSelectLastError =9 |
| Getting only: retrieves the last error. | |
| const TUint | KSOEnableTransfer = 10 |
| Setting only. | |
| const TUint | KSODisableTransfer = 11 |
| Setting only. | |
| const TInt | KSocketBufSizeUndefined =0 |
| Use default buffer size. | |
| const TInt | KSocketDefaultBufferSize =4096 |
| Default buffer size. | |
| const TUint | KSocketInternalOptionBit =0x80000000 |
| const TUint | KIOctlSelect =1 |
| The aDesc parameter of RSocket::Ioctl() specifies a TUint containing a bitmask of Socket status constants. | |
| const TUint | KSockSelectRead =0x00000001 |
| Data is available to be read; for listening sockets, a connect is pending. | |
| const TUint | KSockSelectWrite =0x00000002 |
| Writing to the socket is not currently blocked by flow-control. | |
| const TUint | KSockSelectExcept =0x00000004 |
| An error has occurred. | |
| const TUint | KSockSelectReadContinuation = 0x01000000 |
| Include tail of prior read datagram as available data (ie indicates next read will be with read continuation) | |
| const TUint | KSockWriteUrgent =0x00000001 |
| The data to be sent is urgent and is given a higher priority than ordinary data in the send queue. | |
| const TUint | KSocketInternalWriteBit =0x80000000 |
| Must not be set for client requests. | |
| const TUint | KSockWriteSystemMask =0xFF000000 |
| The top 8 bits are reserved for system purposes; protocols must not define these bits. | |
| const TUint | KSockReadPeek =0x00000001 |
| Read data without consuming it, data remains in the receive queue. | |
| const TUint | KSocketInternalReadBit =0x80000000 |
| Must not be set for client requests. | |
| const TUint | KSockReadContinuation = 0x01000000 |
| Read from datagram in a stream-like fashion (not discarding tails). | |
| const TUint | KSIConnectionLess =0x00000001 |
| The protocol is connectionless. | |
| const TUint | KSIReliable =0x00000002 |
| The protocol is reliable. | |
| const TUint | KSIInOrder =0x00000004 |
| The protocol guarantees in-order delivery. | |
| const TUint | KSIMessageBased =0x00000008 |
| The protocol is message based. | |
| const TUint | KSIDatagram =KSIMessageBased |
| The same as message based. | |
| const TUint | KSIStreamBased =0x00000010 |
| The protocol is stream based. | |
| const TUint | KSIPseudoStream =0x00000020 |
| The protocol supports a stream like interface but maintains datagram boundaries. | |
| const TUint | KSIUrgentData =0x00000040 |
| The protocol offers an expedited data service. | |
| const TUint | KSIConnectData =0x00000080 |
| The protocol can send user data on a connection request. | |
| const TUint | KSIDisconnectData =0x00000100 |
| The protocol can send user data on a disconnect request. | |
| const TUint | KSIBroadcast =0x00000200 |
| The protocol supports broadcast addresses. | |
| const TUint | KSIMultiPoint =0x00000400 |
| The protocol supports point to multi-point connections. | |
| const TUint | KSIQOS =0x00000800 |
| The protocol supports a quality of service metric. | |
| const TUint | KSIWriteOnly =0x00001000 |
| The protocol is write only. | |
| const TUint | KSIReadOnly =0x00002000 |
| The protocol is read only. | |
| const TUint | KSIGracefulClose =0x00004000 |
| The protocol supports graceful close. | |
| const TUint | KSICanReconnect =0x00008000 |
| The same socket can be reconnected if it disconnects (for whatever reason). | |
| const TUint | KSIPeekData =0x00010000 |
| Protocol supports peeking (looking at the data without removing it from the protocol). | |
| const TUint | KSIRequiresOwnerInfo =0x00020000 |
| Protocol is to be informed of the identity of the client (i.e. | |
| const TUint | KSIReserved =0xFFFC0000 |
| const TUint | KNSNameResolution =0x00000001 |
| Protocol supports resolving human readable entity names into network addresses (like DNS). | |
| const TUint | KNSHierarchicalNaming =0x00000002 |
| Network naming is hierarchical. | |
| const TUint | KNSHeirarchicalNaming =KNSHierarchicalNaming |
| const TUint | KNSRemoteDiscovery =0x00000004 |
| Addressing is dynamic and should be attempted every time before connecting (like IrDA). | |
| const TUint | KNSServiceResolution =0x00000008 |
| Protocol supports service name to port number resolution. | |
| const TUint | KNSNameRegistration =0x00000010 |
| Protocol supports additions to the name database. | |
| const TUint | KNSServiceRegistration =0x00000020 |
| Protocol supports additions to the service database. | |
| const TUint | KNSDynamicAddressing =0x00000040 |
| Addressing is dynamic - i.e. | |
| const TUint | KNSInfoDatabase =0x00000080 |
| Protocol has another database which is defined by the protocol. | |
| const TUint | KNSRequiresConnectionStartup =0x00000100 |
| 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. | |
| const TUint | KNSReserved =0xFFFFFE00 |
| const TUint | KSocketNoSecurity =0x00000000 |
| No security. | |
| const TUint | KSecureSockets =0x00000001 |
| Secure Sockets Layer. | |
| const TInt | KSocketMessageSizeIsStream =0 |
| Reads and writes can be of any size: the data is treated as a stream. | |
| const TInt | KSocketMessageSizeUndefined =1 |
| Depends on lower layer or is dynamic. | |
| const TInt | KSocketMessageSizeNoLimit =-1 |
| Data is packet-oriented but packets can be of any size (i.e. | |
| const TUint | KUndefinedSockType =0xFFFFFFFF |
| Undefined socket type. | |
| const TUint | KUndefinedProtocol =0xFFFFFFFE |
| Undefined socket type. | |
| const TUint | KUndefinedAddressFamily = 0 |
| Undefined address family. | |
| const TInt | KErrWouldBlock =-1000 |
| 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. | |
| const TInt | KErrConnectionTerminated =-17210 |
| socket errors | |
| const TInt | KErrCannotFindProtocol = Den::KErrPlayerNotFound |
| const TInt | KErrTierNotFound = -17212 |
| const TInt | KErrConnectionContention = -17213 |
| const TInt | KErrProtocolNotReady = -17214 |
| The protocol requested for the socket was recognised but was not able to be used. | |
| const TUint | KConnectionTypeDefault = 0x0800 |
| Default connection type. | |
| const TInt32 | KSubConnParamsInterfaceUid = 0x10204303 |
| const TInt32 | KSubConnEventInterfaceUid = 0x10204305 |
| const TInt32 | KSubConnGenericParamsImplUid = 0x10204304 |
| const TInt32 | KSubConnGenericEventsImplUid = 0x10204306 |
| const TUint32 | KSubConGlobalFamily = 0 |
| const TUint32 | KSubConQoSFamily = 1 |
| const TUint32 | KSubConAuthorisationFamily = 2 |
| const TUint32 | KSubConnCallDescrParamsFamily = 3 |
| const TUint32 | KSubConnContextDescrParamsFamily = 4 |
| const TUint32 | KSubConIPAddressInfoFamily = 5 |
| const TInt32 | KProtocolExtensionFamily = 6 |
| const TInt32 | KFlowParametersFamily = 7 |
| const TInt | KNotificationEventMaxSize = 2048 |
Definition in file es_sock.h.
| typedef TPckgBuf<TNameRecord> TNameEntry |
Packages the TNameRecord class so that it can be passed between a client and the socket server.
| typedef TPckgBuf<TNifProgress> TNifProgressBuf |
| typedef TBuf<0x20> TProtocolName |
Contains the name of a protocol in structure TProtocolDesc.
| typedef TBuf<0x20> TServiceName |
| typedef TPckgBuf<TInt> TSockXfrLength |
| typedef TBuf8<KMaxSubConnectionEventSize> TSubConnectionNotificationBuf |
| typedef TUint TSubConnectionUniqueId |
| enum TByteOrder |
Used in structure TProtocolDesc to describes the endianness of a protocol.
| Enumerator | |
|---|---|
| EBigEndian | Big endian. |
| ELittleEndian | Little endian. |
| EOtherByteOrder | Other byte order. |
| _LIT8 | ( | SOCKET_SERVER_BT_MODULE_NAME | , |
| "ESock_Bt" | |||
| ) |
| _LIT8 | ( | SOCKET_SERVER_IP_MODULE_NAME | , |
| "ESock_IP" | |||
| ) |
| _LIT8 | ( | SOCKET_SERVER_IR_MODULE_NAME | , |
| "ESock_Ir" | |||
| ) |
| _LIT8 | ( | SOCKET_SERVER_MAIN_MODULE_NAME | , |
| "ESock_Main" | |||
| ) |
Canonical names for the core ESOCKSVR modules.
| _LIT8 | ( | SOCKET_SERVER_SMSWAP_MODULE_NAME | , |
| "ESock_SmsWap" | |||
| ) |
| const TUint KAFUnspec =0 |
| const TUint KConnectionDown = 8000 |
| const TUint KConnectionTypeDefault = 0x0800 |
| const TUint KConnectionUp = 7000 |
| const TInt KErrCannotFindProtocol = Den::KErrPlayerNotFound |
| const TInt KErrConnectionTerminated =-17210 |
| const TInt KErrProtocolNotReady = -17214 |
| const TInt KErrWouldBlock =-1000 |
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 TUint KESockDefaultMessageSlots =8 |
| const TUint KIOctlSelect =1 |
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.
| const TUint KMaxSockAddrSize =0x20 |
| const TUint KMaxSubConnectionEventSize = 512 |
Size of Maximum SubConnection event.
| const TUint KNSDynamicAddressing =0x00000040 |
| const TUint KNSHeirarchicalNaming =KNSHierarchicalNaming |
| const TUint KNSHierarchicalNaming =0x00000002 |
| const TUint KNSInfoDatabase =0x00000080 |
| const TUint KNSNameRegistration =0x00000010 |
| const TUint KNSNameResolution =0x00000001 |
| const TUint KNSRemoteDiscovery =0x00000004 |
| const TUint KNSRequiresConnectionStartup =0x00000100 |
| const TUint KNSReserved =0xFFFFFE00 |
| const TUint KNSServiceRegistration =0x00000020 |
| const TUint KNSServiceResolution =0x00000008 |
| const TUint KSecureSockets =0x00000001 |
| const TUint KSIBroadcast =0x00000200 |
| const TUint KSICanReconnect =0x00008000 |
| const TUint KSIConnectData =0x00000080 |
| const TUint KSIConnectionLess =0x00000001 |
| const TUint KSIDatagram =KSIMessageBased |
| const TUint KSIDisconnectData =0x00000100 |
| const TUint KSIGracefulClose =0x00004000 |
| const TUint KSIInOrder =0x00000004 |
| const TUint KSIMessageBased =0x00000008 |
| const TUint KSIMultiPoint =0x00000400 |
| const TUint KSIPeekData =0x00010000 |
| const TUint KSIPseudoStream =0x00000020 |
| const TUint KSIQOS =0x00000800 |
| const TUint KSIReadOnly =0x00002000 |
| const TUint KSIReliable =0x00000002 |
| const TUint KSIRequiresOwnerInfo =0x00020000 |
| const TUint KSIReserved =0xFFFC0000 |
| const TUint KSIStreamBased =0x00000010 |
| const TUint KSIUrgentData =0x00000040 |
| const TUint KSIWriteOnly =0x00001000 |
| const TUint KSOBlockingIO =5 |
| const TInt KSocketBufSizeUndefined =0 |
| const TInt KSocketDefaultBufferSize =4096 |
| const TUint KSocketInternalReadBit =0x80000000 |
| const TUint KSocketInternalWriteBit =0x80000000 |
| const TInt KSocketMessageSizeIsStream =0 |
| const TInt KSocketMessageSizeNoLimit =-1 |
| const TInt KSocketMessageSizeUndefined =1 |
| const TUint KSocketNoSecurity =0x00000000 |
| const TUint KSockReadContinuation = 0x01000000 |
| const TUint KSockReadPeek =0x00000001 |
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.
| const TUint KSockSelectExcept =0x00000004 |
| const TUint KSockSelectRead =0x00000001 |
| const TUint KSockSelectReadContinuation = 0x01000000 |
| const TUint KSockSelectWrite =0x00000002 |
| const TUint KSockSeqPacket =3 |
| const TUint KSockStream =1 |
| const TUint KSockWriteSystemMask =0xFF000000 |
| const TUint KSockWriteUrgent =0x00000001 |
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.
| const TUint KSODebug =1 |
| const TUint KSODisableTransfer = 11 |
| const TUint KSOEnableTransfer = 10 |
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 TInt KSOLSocket =1 |
| const TUint KSONonBlockingIO =4 |
| const TUint KSOReadBytesPending =7 |
| const TUint KSORecvBuf =2 |
| const TUint KSOSelectLastError =9 |
| const TUint KSOSelectPoll =6 |
| const TUint KSOSendBuf =3 |
| const TUint KSOUrgentDataOffset =8 |
| const TUint KUndefinedAddressFamily = 0 |
| const TUint KUndefinedProtocol =0xFFFFFFFE |
| const TUint KUndefinedSockType =0xFFFFFFFF |
1.9.8