getsockopt

getsockopt

getsockopt 함수는 설정된 소켓 옵션의 값을 얻어내는 함수 입니다.

int getsockopt (
        SOCKET   s,
        int   level,
        int   optname,
        char FAR*   optval,
        int FAR*   optlen
);

Parameters

s
[입력] 작업 대상 소켓의 기술자(descriptor)를 명시합니다.

level
[입력] 소켓 옵션 레벨이 정의 되며, SOL_SOCKET 과 IPPROTO_TCP 중 하나가 될 수 있습니다.

optname
[입력]이 함수에 의해서 반환될(검색될) 값에대한 소켓 옵션을 명시합니다.

optval
[출력] 요청된 옵션에 대한 반환되는 옵션값이 저장될 버퍼에 대한 포인터 입니다.

optlen
[입/출력] optval 버퍼의 크기를 나타내는 정수로 포인트 합니다.

Remarks

getsockopt 함수는 특정한 형태(type), 특정한 상태(state)로 연관 되어있는 소켓옵션에 대해 설정되어 있는 값을 optval 매개변수에 저장해서 얻어내는 함수입니다. 옵션은 중복 프로토콜 레벨로 존재 할 수 있지만. 가장 우선시 되는 소켓 레벨은 존재합니다. 이러한 옵션은 패킷라우팅이나, out-of-band 데이터의 전송등과 같은 소켓연산에 영향을 미칩니다.

선택된 옵션과 연관된 값은 optval 버퍼로 반환 됩니다. optlen 으로 포인트 되는 정수값은 입력시에 optval 버퍼의 크기를 가지고 있어야 합니다. 반환할 때는, 반환되는 값의 크기로 optlen은 셋팅될 것입니다. 예를들어 SO_LINGER 소켓옵션을 사용할 경우에 optlen 값은 LINGER 구조체의 크기를 명시해야 합니다. 대부분의 다른 옵션들은 정수형(integer)의 크기입니다.

어플리케이션은 명시된 매개변수에 의해서 직접적으로 또는 간접적으로 메모리 공간을 할당하는데 책임을 져야 합니다.

옵션이 setsockopt 함수로 셋팅된적이 없다면, getsockopt 함수는 옵션에 대한 디폴트 값을 반환하게 됩니다.

아래에 getsockopt 함수에 대해서 지원되는 옵션에 대해서 간략히 나열하고 설명 했습니다.

level = SOL_SOCKET

옵션값(Value)	데이터형태(Type)	의미(Meaning)
SO_ACCEPTCONN	BOOL	TRUE 일 경우 소켓이 리슨 하고 있습니다.
SO_BROADCAST	BOOL	TRUE 일 경우 소켓은 브로드캐스트(broadcast) 메시지를 전송하기 위해 만들어졌습니다.
SO_DEBUG	BOOL	TRUE 일 경우 디버깅이 가능합니다.
SO_DONTLINGER	BOOL	TRUE 일 경우 SO_LINGER 옵션은 무시됩니다.
SO_DONTROUTE	BOOL	TRUE 일 경우 라우팅이 무시됩니다.
SO_ERROR	int	에러상태를 반환하고, 클리어 됩니다.
SO_GROUP_ID	GROUP	소켓이 속해있는 그룹 식별자를 의미합니다.
SO_GROUP_PRIORITY	int	소켓에 관련된 우선사항은 소켓 그룹의 부분 입니다.
SO_KEEPALIVE	BOOL	TRUE 일 경우 keepalive가 전송되고 있습니다.
SO_LINGER	struct LINGER	현재의 linger 옵션을 반환 합니다.
SO_MAX_MSG_SIZE	unsigned int	SOCK_DGRAM 과 같은 소켓 형태에서 메시지의 최대 크기입니다. 스트림 소켓에서는 아무런 의미가 없습니다.
SO_OOBINLINE	BOOL	TRUE 일 경우 아웃오브밴드 데이터가 정상적인 데이터 스트림으로 수신되고 있습니다.
SO_PROTOCOL_INFO	WSAPROTOCOL_INFO	소켓에 대해 바인드된 프로토콜 정보를 나타냅니다.
SO_RCVBUF	int	수신 버퍼크기를 의미합니다.
SO_REUSEADDR	BOOL	TRUE일 경우 소켓은 이미 사용중인 어드레스로 묶였습니다.
SO_SNDBUF	int	전송 버퍼의 크기
SO_TYPE	int	소켓의 타입 (예:SOCK_STREAM, SOCK_DGRAM)

level = IPPROTO_TCP

TCP_NODELAY

BOOL

전송합병(send coalescing)을 위해 Nagle 알고리즘이 비활성화 되었습니다.

Return Values

에러가 발생하지 않았을 경우 0을 반환합니다. 에러가 발생한 경우는 SOCKET_ERROR를 반환하고, WSAGetLastError 함수를 이용해서 특정한 에러코드 값을 얻어낼 수 있습니다.

Error Codes

WSANOTINITIALISED	이 함수를 사용하기 전에 성공적인 WSAStartup 함수의 호출이 없었습니다.
WSAENETDOWN	네트웍 서브 시스템에 에러가 발생했습니다.
WSAEFAULT	optval 또는 optlen 매개변수 중의 하나가 올바르지 않거나 optlen 매개변수의 값이 너무 작습니다.
WSAEINPROGRESS	블럭킹 윈속 v1.1 이 현재 진행 중이거나, 서비스 프로바이더가 콜백 함수를 여전히 처리하고 있습니다.
WSAEINVAL	level 매개변수가 잘못됐거나, 알 수 없는 값 입니다.
WSAENOPROTOOPT	알 수 없는 옵션이거나, 지원지지 않는 옵션을 사용 했습니다.
WSAENOTSOCK	기술자(descriptor)가 소켓 기술자가 아닙니다.

QuickInfo

Windows NT : 사용가능
Windows : 사용가능
Windows CE : 버젼 1.0 그리고 그이후의 버젼에서 사용가능
Header :
          Win16/32 : winsock.h
          Win32-II : winsock2.h
Import Library :
         Win16 : winsock.lib
          Win32 : wsock32.lib
          Win32-II : ws2_32.lib

See Also