CAsyncSocket::GetSockOpt

BOOL Виклику GetSockOpt ( int nOptionName, порожнечу * lpOptionValue, int * lpOptionLen, int nLevel = SOL_SOCKET );

Значення, яке повертається

Ненульовий, якщо функція успішно; в іншому випадку 0 і кодом помилки можуть бути отримані за номером GetLastError. Якщо параметр був ніколи не з setsockopt вказано, виклику GetSockOpt повертає значення за промовчанням для параметра. Такі помилки застосовуються до цієї функції-члени:

WSA&NOTINITIALISEDnbsp; Успішних AfxSocketInit має бути ранішим за допомогою цього API.
WSAE&NETDOWNnbsp; Реалізація Windows Sockets виявлено, що мережної підсистеми не вдалося.
WSAEFAULT Неприпустимий аргумент lpOptionLen ».
WSAEI&NPROGRESSnbsp; Виконується операція блокування Windows Sockets.
WSAE&NOPROTOOPTnbsp; Параметр є невідомий або не підтримується. Зокрема, SO_BROADCAST не підтримується на розетки типу SOCK_STREAM, SO_ACCEPTCONN, SO_DONTLINGER, SO_KEEPALIVE, SO_LINGERі SO_OOBINLINE не підтримуються на розетки типу SOCK_DGRAM.
WSAE&NOTSOCKnbsp; На дескриптор не є панельку.

Параметри

nOptionName

Параметр сокет, для яких значення є отримання.

lpOptionValue

Вказівник миші в буфер значень для потрібний параметр, щоб повернути. В буфер lpOptionValueповертається значення, пов'язані з вибраним параметром. Ціле число, яке вказує на lpOptionLen спочатку повинні містити розмір буфера, в байтах; і на повернення, вона буде створена розміру значення яке повертається. Для SO_LINGERце буде розмір ЗАТРИМУВАТИСЯ структури; для всіх інших варіантів буде розмір BOOL або на int, залежно від параметра. Переглянути список параметрів і їх розмірів у розділі зауваження.

lpOptionLen

Вказівник на розмір lpOptionValue буфера в байт.

nLevel

Рівні, на якій визначається параметром; Єдиний підтримуваний рівні є SOL_SOCKET і IPPROTO_TCP.

Зауваження

Телефонуйте цієї функції-члена для отримання socket варіант. Виклику GetSockOpt повертає поточне значення параметра сокет, пов'язані з socket будь-якого типу, в будь-який стан і зберігає результати в lpOptionValue. Параметри впливають на socket операцій, таких, як маршрутизації пакетів, передачі даних-бенд і так далі.

Для виклику GetSockOptпідтримуються такі параметри. Тип визначає тип даних, які розглядаються на lpOptionValue. TCP_NODELAY параметр використовує рівня IPPROTO_TCP; всі інші можливості використовувати рівня SOL_SOCKET.

Значення	Тип	Значення
SO_ACCEPTCONN	BOOL	Сокет слухати.
SO_BROADCAST	BOOL	Socket настроєно для передачі трансляцію повідомлень.
SO_DEBUG	BOOL	Налагодження включений.
SO_DONTLINGER	BOOL	Якщо це правда, SO_LINGER параметр вимкнено.
SO_DONTROUTE	BOOL	Маршрутизація вимкнуто.
SO_ERROR	int	Отримати відомості про помилку стан і зніміть.
SO_KEEPALIVE	BOOL	Зберегти alives будуть відправлені.
SO_LINGER	структура ЗАТРИМУВАТИСЯ	Повертає параметри поточного затримуватися.
SO_OOBINLINE	BOOL	-Група даних отримано в потоці дані нормалей.
SO_RCVBUF	int	Розмір буфера для отримує.
SO_REUSEADDR	BOOL	Сокет можна прив'язати на адресу, яка вже використовується.
SO_SNDBUF	int	Розмір буфера для надсилання.
SO_TYPE	int	Типу сокету (наприклад, SOCK_STREAM).
TCP_NODELAY	BOOL	Вимикає раптом алгоритм для надсилання, які зливаються.

Розповсюдження програмного забезпечення Берклі (BSD) параметри не підтримуються для виклику GetSockOpt:

Значення	Тип	Значення
SO_RCVLOWAT	int	Отримувати Марк низький рівень води.
SO_RCVTIMEO	int	Отримати час очікування.
SO_SNDLOWAT	int	Надіслати Марк низький рівень води.
SO_SNDTIMEO	int	Надіслати тайм-аут.
IP_OPTIONS		Отримати параметри IP заголовка.
TCP_MAXSEG	int	Отримати максимальну сегмент розмір TCP.

Виклик виклику GetSockOpt з непідтримуваний параметр призведе з WSAENOPROTOOPT , що повернувся з GetLastError код помилки.

Огляд CAsyncSocket |nbsp; Члени класу | Ієрархічна діаграма

Дивіться також CAsyncSocket::SetSockOpt

Index