ProtocolClIncomingCall (NDIS 5.1) function

Article
06/19/2017

Note NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

The ProtocolClIncomingCall function is used by connection-oriented clients that accept incoming calls. Such clients must have ProtocolClIncomingCall functions. Otherwise, such a protocol driver's registered ProtocolClIncomingCall function can simply return NDIS_STATUS_NOT_SUPPORTED.

Syntax

NDIS_STATUS ProtocolClIncomingCall(
  _In_    NDIS_HANDLE         ProtocolSapContext,
  _In_    NDIS_HANDLE         ProtocolVcContext,
  _Inout_ PCO_CALL_PARAMETERS CallParameters
);

Parameters

ProtocolSapContext [in]
Specifies the handle that the client originally supplied when it registered the SAP, which the call manager matched to this incoming call offer.
ProtocolVcContext [in]
Specifies the handle to the client's per-VC context area, previously returned to NDIS by its ProtocolCoCreateVc function.
CallParameters [in, out]
Pointer to a buffer, formatted as a CO_CALL_PARAMETERS structure, that contains the call parameters for this offered call.

Return value

ProtocolClIncomingCall returns NDIS_STATUS_SUCCESS if the client accepts the incoming call offer. Any other client-determined status indicates its rejection of the offered call.

Remarks

A call to ProtocolClIncomingCall indicates that the call manager has received a request over the network from a signaling peer to establish a connection with this client. That is, the request to set up such a connection was directed to a SAP previously registered with the call manager by this client.

Depending on the signaling protocol supported by the call manager, ProtocolClIncomingCall can modify the traffic parameters as part of the process of negotiating acceptance of an incoming call offer and/or, if the call manager supports QoS, the quality of service specification at CallParameters. The client should copy any information it will need subsequently from this buffered structure if it accepts the offered call.

Assuming the call manager finds the client's modifications, if any, acceptable, NDIS next calls the client's ProtocolClIncomingCallConnected function when it becomes possible for transfers to occur on the active VC representing the connection to the client on the remote node that originally initiated the call offer. If the client returns modified call parameters that are unacceptable, the call manager can tear down the VC it created for this offer, thereby causing calls to the client's ProtocolClIncomingCloseCall and then ProtocolCoDeleteVc functions instead.

Requirements

Target platform	Desktop
Version	See ProtocolClIncomingCall.
Header	Ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL

Share via