Struttura WSAMSG (ws2def.h)

La struttura WSAMSG viene usata con le funzioni LPFN_WSARECVMSG WSARecvMsg (WSARecvMsg) e WSASendMsg per archiviare informazioni di controllo e indirizzo su socket connessi e non connessi, nonché una matrice di buffer usati per archiviare i dati dei messaggi.

Sintassi

typedef struct _WSAMSG {
  LPSOCKADDR name;
  INT        namelen;
  LPWSABUF   lpBuffers;
#if ...
  ULONG      dwBufferCount;
#else
  DWORD      dwBufferCount;
#endif
  WSABUF     Control;
#if ...
  ULONG      dwFlags;
#else
  DWORD      dwFlags;
#endif
} WSAMSG, *PWSAMSG, *LPWSAMSG;

Members

name

Tipo: LPSOCKADDR

Puntatore a una struttura SOCKET_ADDRESS che archivia informazioni sull'indirizzo remoto. Usato solo con socket non connessi.

namelen

Tipo: INT

Lunghezza, in byte, della struttura SOCKET_ADDRESS a cui punta nel membro pAddr . Usato solo con socket non connessi.

lpBuffers

Tipo: LPWSABUF

Matrice di strutture WSABUF usate per ricevere i dati del messaggio. La funzionalità del membro lpBuffers per contenere più buffer consente l'uso di I/O a dispersione/raccolta.

dwBufferCount

Tipo: DWORD

Numero di buffer a cui punta il membro lpBuffers .

Control

Tipo: WSABUF

Struttura di tipo WSABUF usata per specificare i dati di controllo facoltativi. Vedere la sezione Osservazioni.

dwFlags

Tipo: DWORD

Uno o più flag di controllo, specificati come OR logico dei valori. I valori possibili per i membri dwFlags nell'input sono definiti nel file di intestazione Winsock2.h. I valori possibili per i membri dwFlags nell'output sono definiti nel file di intestazione Ws2def.h che viene incluso automaticamente dal file di intestazione Winsock2.h.

Commenti

In Microsoft Windows Software Development Kit (Windows SDK) (SDK), la versione di questa struttura da usare in Windows Vista viene definita con il tipo di dati per i membri dwBufferCount e dwFlags come ULONG. Quando si compila un'applicazione se la piattaforma di destinazione è Windows Vista e versioni successive (NTDDI_VERSION = NTDDI_LONGHORN, _WIN32_WINNT >= 0x0600 >o WINVER >= 0x0600), il tipo di dati per i membri dwBufferCount e dwFlags è un ULONG.

Windows Server 2003 e Windows XP: Quando si compila un'applicazione, il tipo di dati per i membri dwBufferCount e dwFlags è una DWORD.

Nella Windows SDK rilasciata per Windows Vista e versioni successive, la struttura WSAMSG viene definita nel file di intestazione Ws2def.h. Si noti che il file di intestazione Ws2def.h viene incluso automaticamente in Winsock2.h e non deve mai essere usato direttamente

Se i dati del datagram o del controllo vengono troncati durante la trasmissione, la funzione usata in associazione alla struttura WSAMSG restituisce SOCKET_ERROR e una chiamata alla funzione WSAGetLastError restituisce WSAEMSGSIZE. L'applicazione deve determinare cosa è stato troncato controllando MSG_TRUNC e/o MSG_CTRUNC flag.

Uso del membro del controllo

La tabella seguente riepiloga i vari usi dei dati di controllo disponibili per l'uso nel membro Control per IPv4 e IPv6.

I dati di controllo sono costituiti da uno o più oggetti dati di controllo, ognuno che inizia con una struttura WSACMSGHDR , definita come segue.

struct wsacmsghdr {
  UINT        cmsg_len;
  INT         cmsg_level;
  INT         cmsg_type;
  /* followed by UCHAR cmsg_data[] */
} WSACMSGHDR;

I membri della struttura WSACMSGHDR sono i seguenti:

Per spostarsi tra gli oggetti dati vengono utilizzate le macro seguenti:

#define LPCMSGHDR *WSA_CMSG_FIRSTHDR(LPWSAMSG msg);

Restituisce un puntatore al primo oggetto dati del controllo. Restituisce un puntatore NULL se non sono presenti dati di controllo nella struttura WSAMSG , ad esempio quando il membro Control è un puntatore NULL .

#define LPCMSGHDR *WSA_CMSG_NXTHDR(LPWSAMSG msg, LPWSACMSGHDR cmsg);

Restituisce un puntatore all'oggetto dati del controllo successivo o NULL se non sono presenti più oggetti dati. Se il parametro pcmsg è NULL, viene restituito un puntatore al primo oggetto dati del controllo.

#define UCHAR *WSA_CMSG_DATA(LPWSACMSGHDR pcmsg);

Restituisce un puntatore al primo byte di dati (detto membro cmsg_data , anche se non è definito nella struttura).

#define UINT WSA_CMSG_SPACE(UINT length);

Restituisce la dimensione totale di un oggetto dati del controllo, in base alla quantità di dati. Usato per allocare la quantità corretta di spazio buffer. Include la spaziatura interna dell'allineamento.

#define UINT WSA_CMSG_LEN(UINT length);

Restituisce il valore in cmsg_len in base alla quantità di dati. Include la spaziatura interna dell'allineamento.

Requisiti

Vedi anche

IPV6_PKTINFO

IP_PKTINFO

SOCKET_ADDRESS

WSABUF

WSARecv

WSARecvFrom

LPFN_WSARECVMSG (WSARecvMsg)

WSASendMsg