SDK Home Glossary Index Left Right Up

Socket options

Defined in

csocket.oxh

Definitions
Name Level Description Get parameter Set parameter
Generic sockets
KSoDebug& KSoLSocket& Enable or disable debugging Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoRecvBuf& KSoLSocket& Set socket receive buffer size   Integer
KSoSendBuf& KSoLSocket& Set socket send buffer size   Integer
KSoNonBlockingIO& KSoLSocket& Socket non-blocking mode.   Integer

0 = Disable
1 = Enable

KSoBlockingIO& KSoLSocket& Socket blocking mode.   Integer

0 = Disable
1 = Enable

KSoSelectPoll& KSoLSocket& A bitmask of flags describing the read/write/exception status of the socket. Integer  
KSoReadBytesPending& KSoLSocket& For TCP, the number of bytes currently available for reading.

For UDP, the number of queued datagrams

Integer  
KSoUrgentDataOffset& KSoLSocket& The offset to the next urgent data. Integer  
KSoSelectLastError& KSoLSocket& Retrieves the last error. This is used in combination with the SocketIoctl:() command KSockSelectExcept&. Integer  
Network interface
KSoInetEnumInterfaces& KSolInetIfCtrl& Begin enumeration of network interfaces   Not required.
KSoInetNextInterface& KSolInetIfCtrl& Return details of the next interface in an enumeration started by setting the option KSoInetEnumInterfaces& Interface information  
KSoInetConfigInterface& KSolInetIfCtrl& Return details of the specified interface. The interface can be specified by setting the Address, Tag, Name of HwAddr of the passed Interface information. The complete details are passed back in the same object. Interface information  
Routing
KSoInetEnumRoutes& KSolInetRfCtrl& Begin enumeration of routes. This option should be set before enumerating routes.   Not required
KSoInetNextRoute& KSolInetRfCtrl& Return the next route in an enumeration started by setting the option KSoInetEnumRoutes& Routing information  
KSoInetAddRoute& KSolInetRfCtrl& Adds a new route   Routing information
KSoInetDeleteRoute& KSolInetRfCtrl& Deletes an existing route   Routing information
KSoInetChangeRoute& KSolInetRfCtrl& Modifies the specified route in the routing table. The destination and netmask settings must be the same in the new route as in the old.   Routing information
KSoInetCachedRouteByDest& KSolInetRfCtrl& Get a cached routing entry Cached Route information  
TCP/IP
KSoTcpSendWinSize& KSolInetTcp& use before SocketConnect. The maximum number of bytes that can be buffered for sending.

The default value is 8192.

Integer Integer
KSoTcpRecvWinSize& KSolInetTcp& use before SocketConnect. The maximum number of bytes that can be buffered for receiving.

The default value is 8192.

Integer Integer
KSoTcpMaxSegSize& KSolInetTcp& use before SocketConnect. The maximum TCP segment size (in bytes).

The default size is 1460.

Integer Integer
KSoTcpNextSendUrgentData& KSolInetTcp& The next send operation will mark the last byte sent as urgent data.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoTcpNoDelay& KSolInetTcp& Send data at once if there is an established connection, without waiting for the maximum segment size to be reached.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoTcpKeepAlive& KSolInetTcp& On the time-out expiring without an acknowledgement being received, send a packet designed to forace a response if the peer is up and reachable.

Default is disabled

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoTcpOobInline& KSolInetTcp& Receive out-of-band data in the normal data stream.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoTcpAsync2MslWait& KSolInetTcp& If address reuse is allowed, and a connection already exists between the requested local and remote addresses, wait for the address to become available.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoTcpSendBytesPending& KSolInetTcp& The number of bytes currently queued for sending. Integer  
KSoTcpReadBytesPending& KSolInetTcp& The number of bytes currently available for reading (the same value as is obtained using KSOReadBytesPending&) Integer  
KSoTcpListening& KSolInetTcp& The socket has been set ot listen Integer

0 = Not listening
1 = Listening

 
KSoTcpNumSockets& KSolInetTcp& The number of current TCP sockets. Integer  
KSoTcpPeekUrgentData& KSolInetTcp& Peeks for urgent data. The behaviour is the same as KSoTcpReadUrgentData but the urgetn data is not removed. Integer  
KSoTcpRcvAtMark& KSolInetTcp& True if the data stream has been read up to the point where urgent data is available, other false Integer

0 = false
1 = true

 
KSoTcpReadUrgentData& KSolInetTcp& Read out-of-band urgent data. Integer  
KSoTcpDebugMode&     Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

UDP
KSoUdpReceiveICMPError& KSolInetUdp& Inform client of error if ICMP error packets received.

Default is enabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

IP Datagram
KSoIpOptions& KSolInetIp& Data to place in IP Options field of sent datagrams <TBS> <TBS>
KSoRawMode& KSolInetIp& Include IP header in data returned to client.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoHeaderIncluded& KSolInetIp& Assume that the IP header is included in all data written by the client. KSoRawMode& must be set before this is allowed.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

IP
KSoIpTOS& KSolInetIp& Type of Service field of outgoing datagrams.

Default is 0.

Integer

0-63

Integer

0-63

KSoIpTTL& KSolInetIp& Time to Live field of outgoing datagrams.

Default value is 255.

Integer

1-255

Integer

1-255

KSoReuseAddr& KSolInetIp& Allow a socket to be bound to a local address that is already in use.

Default is disabled.

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoNoInterfaceError& KSolInetIp& Do not return an error if there are no avaible routes when a connect call uis made.

Default is disabled

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoInetLastError& KSolInetIp& Gets the last error Last error  
Network interface start-up and shutdown
KNifOptStartInterface& KNifOptLevel& Start the named network interface   Descriptor
KNifOptStopInterface& KNifOptLevel& Stop the named interface   Descriptor
KNifOptInterfaceProgress& KNifOptLevel& Returns interface progress information Network Interface Progress  
DNS cache
KSoDnsCacheEnable& KSolInetDnsCtrl& Enable DNS cache flag.

Default is enabled

Integer

0 = Disable
1 = Enable

Integer

0 = Disable
1 = Enable

KSoDnsCacheEnable& KSolInetDnsCtrl& Flush DNS cache   Not required
Network interface driver
KSoIfInfo& KSOLInterface& The current network interface driver operation. Socket option interface information  
KSoIfHardwareAddr& KSOLInterface& The hardware address. Socket option hardware address  
KSoIfConfig& KSOLInterface& The current network interfact driver configuration Socket option interface configuration  
KSoIfCompareAddr& KSOLInterface& Compare the passed address with the current local address and returns KErrBadName if not equal Internet Address  
IR/LAP
KUnexpeditedDataOpt& KLevelIrlap& Sets the transfer mode to unexpedites (default)   Integer
KExpeditedDataOpt& KLevelIrlap& Sets the transfer mode to expedited (urgent)   Integer
KDiscoverySloptsOpt& KLevelIrlap& Sets the number of discovery slots   Integer
KUserBaudOpt& KLevelIrlap& Sets the requested maximum link baud rate. Integer Integer
KHostMaxDataSizeOpt& KLevelIrlap& Sets the requested maxmum data packet size that can be received by the host. Integer Integer
KHostMaxTATimeOpt& KLevelIrlap& The maximum link turnaround time for the host IrLAP layer. Integer Integer
KRemoteMaxDataSizeOpt& KLevelIrlap& The maximum transmissible data size to remote IrLAP layer. Integer  
IR/MIX
KTinyTPRemoteSizeOpt& KLevelIrMUX& The remote machine's segment size. The remote machine is unable to assemble more data than this. Integer  
KTinyTPLocalSizeOpt& KLevelIrMUX& Turns on transport layer segmentation with the segment size specified. This value is advertised to the remote machine as the maximum amount of data we can reassemble.   Integer
See also

SocketSetOpt, SocketSetOptInt


Poll Mask

Defined in

csocket.oxh

Definitions
Constant Description
KSockSelectExcept& An error has occured.
KSockSelectRead& Data is available to be read; for listening sockets, a connect is pending.
KSockSelectWrite& Writing to the socket is not currently blocked by flow control.

  SDK Home Glossary Index Left Right Up