![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
in_sock.h
This section lists constants that identify TCP/IP protocols. They are defined in in_sock.h.
|
This section lists constants that be used to obtain information and set
options through RSocket::GetOpt() and
RSocket::SetOpt(). Unless otherwise noted, a constant can be used
in both functions.
Generic socket options can also be used. Note especially the meaning of the following generic options when applied to TCP/IP:
KSOReadBytesPending: for TCP, the number of bytes
currently available for reading; for UDP, this is the number of queued
datagrams.
KSOUrgentDataOffset: for TCP/IP only, the offset to
the next urgent data.
This section describes the options that can be used both with TCP and UDP sockets.
These values concern DNS cache options. Set
anOptionLevel to KSolInetDnsCtrl. They are defined in
in_sock.h.
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
KSoDnsCacheEnableconst TUint KSoDnsCacheEnable
Enable DNS cache flag.
Default is enabled.
TInt
0. Disable 1. Enable
KSoDnsCacheFlushconst TUint KSoDnsCacheFlush
Flush DNS cache
SetOpt() only.
Not required
These values concern IP options. Set anOptionLevel
toKSolInetIp. They are defined in in_sock.h.
KSoIpTOSconst TUint KSoIpTOS
Type of Service field of outgoing datagrams.
The default value is 0.
TInt
0-63
KSoIpTTLconst TUint KSoIpTTL
Time to Live field of outgoing datagrams.
The default value is 255.
TInt
1-255
KSoNoInterfaceErrorconst TUint KSoNoInterfaceError
Do not return an error if there are no available routes when a connect call is made.
Default is disabled.
TInt
0. Disable 1. Enable
KSoReuseAddrconst TUint KSoReuseAddr
Allow a socket to be bound to an local address that is already in use.
Default is disabled.
TInt
0. Disable 1. Enable
KSoInetLastErrorconst TUint KSoInetLastError
Retrieve last error information.
GetOpt() only.
TPckgBuf< TSoInetLastErr >
These values concern network interface driver options.
SetanOptionLevel to KSOLInterface. They are defined
in in_iface.h.
KSoIfInfoconst TUint KSoIfInfo
The current network interface driver operation parameters are written to
the passed TSoIfInfo structure.
TPckgBuf< TSoIfInfo >
KSoIfHardwareAddrconst TUint KSoIfHardwareAddr
For future use.
KSoIfConfigconst TUint KSoIfConfig
The current network interface driver configuration options are written to
the passed TSoInetIfConfig structure.
TPckgBuf< TSoInetIfConfig >
KSoIfCompareAddrconst TUint KSoIfCompareAddr
Compares the passed address with the current local address, and
returnsKErrBadName if not equal.
TPckgBuf< TInetAddr >
These values concern network interface options.
SetanOptionLevel to KSolInetIfCtrl. They are defined
in in_sock.h.
KSoInetEnumInterfacesconst TUint KSoInetEnumInterfaces
Begin enumeration of network interfaces. This option should be set before
enumerating interfaces by
callingGetOpt()withanOptionName set
toKSoInetNextInterface.
SetOpt() only.
Not required
KSoInetConfigInterfaceconst TUint KSoInetConfigInterface
Return details of the specified interface. The interface can be specified
by setting the iAddress, iTag, iName,
oriHwAddr of the passed TSoInetInterfaceInfo. The
complete details are passed back in the same object.
GetOpt() only.
TPckgBuf< TSoInetInterfaceInfo >
KSoInetNextInterfaceconst TUint KSoInetNextInterface
Return details of the next interface in an enumeration started by setting
the option KSoInetEnumInterfaces.
GetOpt() only.
TPckgBuf< TSoInetInterfaceInfo >
These constants concern network interface start-up and shutdown.
SetanOptionLevel to KNifOptLevel. They are defined in
nifman.h.
KNifOptStartInterfaceconst TUint KNifOptStartInterface
Start the named network interface.
SetOpt() only.
TPtrC
KNifOptStopInterfaceconst TUint KNifOptStopInterface
Stop the named network interface.
SetOpt() only.
TPtrC
KNifOptInterfaceProgressconst TUint KNifOptInterfaceProgress
Returns interface progress information.
GetOpt() only.
TNifProgressBuf
These values concern IP routing options.
SetanOptionLeveltoKSolInetRtCtrl. They are defined in
in_sock.h.
The following options can only be
usedRSocket::SetOpt().
KSoInetEnumRoutesconst TUint KSoInetEnumRoutes
Begin enumeration of routes. This option should be set before enumerating
routes by calling GetOpt() with anOptionName set
toKSoInetNextRoute.
Not required
KSoInetAddRouteconst TUint KSoInetAddRoute
Adds the specified route to the routing table.
TPckgBuf< TSoInetRouteInfo >
KSoInetDeleteRouteconst TUint KSoInetDeleteRoute
Deletes the specified route from the routing table.
TPckgBuf< TSoInetRouteInfo >
KSoInetChangeRouteconst TUint KSoInetChangeRoute
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.
TPckgBuf< TSoInetRouteInfo >
KSoInetCachedRouteByDestconst TUint KSoInetCachedRouteByDest
Find a cached route to a specified destination.
The caller should pass a packaged TSoInetCachedRouteInfowith
its iDstAddr member set to the required address.
TPckgBuf< TSoInetCachedRouteInfo
>
KSoInetNextRouteconst TUint KSoInetNextRoute
Return the next route in an enumeration started by setting the
optionKSoInetEnumRoutes.
TPckgBuf< TSoInetRouteInfo >
This section describes the options that can only be used with UDP sockets.
Set anOptionLevel to KSolInetUdp. It is defined
in in_sock.h.
KSoUdpReceiveICMPErrorconst TUint KSoUdpReceiveICMPError
Inform client of error if ICMP error packets received.
Default is enabled.
TInt
0. Disable 1. Enable
These values concern IP datagram options.
SetanOptionLeveltoKSolInetIp. They are defined in in_sock.h.
KSoIpOptionsconst TUint KSoIpOptions
Data to place in IP Options field of sent datagrams.
TBuf8< TInt >
The maximum length is 40 bytes.
KSoRawModeconst TUint KSoRawMode
Include IP header in data returned to client.
Default is disabled.
TInt
0. Disable 1. Enable
KSoHeaderIncludedconst TUint KSoHeaderIncluded
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.
TInt
0. Disable 1. Enable
|
This section describes the options that can only be used with TCP
sockets. Set anOptionLevel to KSolInetTcp. They are
defined in in_sock.h.
|
This section describes the options that can only be used with TCP
sockets. Set anOptionLevel to KSolInetTcp. They are
defined in in_sock.h.
KSoTcpAsync2MslWaitconst TUint KSoTcpAsync2MslWait
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.
TInt
0. Disable 1. Enable
KSoTcpKeepAliveconst TUint KSoTcpKeepAlive
On the time-out expiring without an acknowledgement being received, send a packet designed to force a response if the peer is up and reachable.
Default is disabled.
TInt
0. Disable 1. Enable
KSoTcpMaxSegSizeconst TUint KSoTcpMaxSegSize
The maximum TCP segment size (bytes).
If this option is set when the connection state is not closed,
thenKErrLocked is returned.
The default value is 1460.
TInt
KSoTcpNextSendUrgentDataconst TUint KSoTcpNextSendUrgentData
The next send operation will mark the last byte sent as urgent data.
Default is disabled.
TInt
0. Disable 1. Enable
KSoTcpNoDelayconst TUint KSoTcpNoDelay
Send data at once if there is an established connection, without waiting for the maximum segment size to be reached.
Default is disabled.
TInt
0. Disable 1. Enable
KSoTcpOobInlineconst TUint KSoTcpOobInline
Receive out-of-band data in the normal data stream.
Default is disabled.
TInt
0. Disable 1. Enable
KSoTcpRecvWinSizeconst TUint KSoTcpRecvWinSize
The maximum number of bytes that can be buffered for receiving.
If this option is set when the connection state is not closed,
thenKErrLocked is returned.
The default value is 8192.
TInt
KSoTcpSendWinSizeconst TUint KSoTcpSendWinSize
The maximum number of bytes that can be queued for sending.
If this option is set when the connection state is not closed,
thenKErrLocked is returned.
The default value is 8192.
TInt
The following options can only be used
withRSocket::GetOpt(),
notRSocket::SetOpt().
KSoTcpListeningconst TUint KSoTcpListening
The socket has been set to listen
(throughRSocket::Listen()).
TInt
0. Not listening 1. Listening
KSoTcpNumSocketsconst TUint KSoTcpNumSockets
The number of current TCP sockets.
TInt
KSoTcpPeekUrgentDataconst TUint KSoTcpPeekUrgentData
Peeks for urgent data. The behaviour is the same
asKSoTcpReadUrgentData, but the urgent data is not removed.
TInt
KSoTcpRcvAtMarkconst TUint KSoTcpRcvAtMark
True if the data stream has been read up to the point where urgent data is available, otherwise false.
TInt
KSoTcpReadBytesPendingconst TUint KSoTcpReadBytesPending
The number of bytes currently available for reading (the same value as is
obtained using KSOReadBytesPending).
TInt
KSoTcpReadUrgentDataconst TUint KSoTcpSendBytesPending
Read out-of-band urgent data.
KErrNotFound is returned if there is no data waiting and no
urgent data pointer has been received.
KErrWouldBlock is returned if and urgent is available but
data needs to be read from the current stream to match the urgent data
mark.
TInt
KSoTcpSendBytesPendingconst TUint KSoTcpSendBytesPending
The number of bytes currently queued for sending.
TInt
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up.gif){kind=icon}