Microsoft DirectX 9.0 SDK Update (Summer 2003)

DPN_CAPS_EX Structure


Used when setting and retrieving parameters to tune the Microsoft® DirectPlay® protocol.

Syntax

typedef struct _DPN_CAPS_EX {
    DWORD dwSize;
    DWORD dwFlags;
    DWORD dwConnectTimeout;
    DWORD dwConnectRetries;
    DWORD dwTimeoutUntilKeepAlive;
    DWORD dwMaxRecvMsgSize;
    DWORD dwNumSendRetries;
    DWORD dwMaxSendRetryInterval;
    DWORD dwDropThresholdRate;
    DWORD dwThrottleRate;
    DWORD dwNumHardDisconnectSends;
    DWORD dwMaxHardDisconnectPeriod;
} DPN_CAPS_EX, *PDPN_CAPS_EX;

Members

dwSize
Value, which must be set to the size of the structure.
dwFlags
Reserved; this must be 0.
dwConnectTimeout
Number of milliseconds DirectPlay should wait before it retries a connection request.
dwConnectRetries
Number of connection retries DirectPlay should make during the connection process.
dwTimeoutUntilKeepAlive
Number of milliseconds DirectPlay waits since the last time it received a packet from an endpoint, before it sends a keep-alive message. The actual delay can vary from the specified value to as much as twice the specified value.
dwMaxRecvMsgSize
Maximum size of received messages, in bytes.
dwNumSendRetries
Maximum number of times applications can try to send a message before the connection is considered dead.
dwMaxSendRetryInterval
Maximum number of milliseconds between attempts to resend messages.
dwDropThresholdRate
Percentage of dropped packets allowed before Message Throttling is applied.
dwThrottleRate
Percentage to reduce the send queue when applying message throttling.
dwNumHardDisconnectSends
Number of hard disconnect frames to send when the DPNCLOSE_IMMEDIATE flag is specified.
dwMaxHardDisconnectPeriod
Maximum time, in milliseconds, between each hard disconnect frame sent.

Remarks

When using the DPN_CAPS_EX structure with IDirectPlay8Peer or IDirectPlay8Client objects, the dwMaxRecvMsgSize member is ignored. Callback functions for IDirectPlay8Peer and IDirectPlay8Client will receive messages of any size, even those larger than dwMaxRecvMsgSize.

Structure Information

Headerdplay8.h
Minimum operating systems Windows 98, Pocket PC 2002


© 2003 Microsoft Corporation. All rights reserved.