Registering and Opening an Address Family

A call manager must register an address family for each NIC on which it provides call manager services to connection-oriented clients. Similarly, an MCM driver must register an address family for the NIC that it manages.

By registering an address family, a call manager or MCM driver causes NDIS to advertise the call manager's or MCM driver's services to all connection-oriented clients that bind to the adapter.

If a connection-oriented client can use the services advertised by a call manager or MCM driver, it can open an address family with the call manager or MCM driver.

Registering an Address Family from a Call Manager

After its ProtocolBindAdapterEx function binds to an underlying miniport driver with NdisOpenAdapterEx, a call manager calls NdisCmRegisterAddressFamilyEx to register an address family for the binding (see the following figure).

Diagram illustrating the process of registering and opening an address family with a call manager.

The call to NdisCmRegisterAddressFamilyEx advertises the call manager's specific signaling services. A call manager must register an address family each time that its ProtocolBindAdapterEx function and is called and successfully binds to a NIC with NdisOpenAdapterEx.

The call manager can support more than one address family across all the miniport drivers to which it is bound. The call manager can also support more than one address family on a single NIC to which it is bound. The call manager must register the same entry points for each address family on the binding. Only one call manager can support a particular type of address family for clients bound to any particular miniport driver. For more information about registering entry points for a call manager, see CoNDIS Registration.

Registering an Address Family from an MCM Driver

An MCM driver calls NdisMCmRegisterAddressFamilyEx from its MiniportInitializeEx function after registering its miniport driver entry points with NdisMRegisterMiniportDriver. For more information about regsitering entry points see, CoNDIS Registration. An MCM driver calls NdisMCmRegisterAddressFamilyEx once to advertise its services to connection-oriented clients (see the following figure).

Diagram illustrating the process of registering and opening an address family with an MCM driver.

A miniport driver of a NIC that has on-board connection-oriented signaling support can register itself as an MCM driver even though a call manager may be available. By doing so, such an MCM driver preempts the call manager as the call manager for that NIC.

Opening an Address Family

A call manager's or MCM driver's call to Ndis(M)CmRegisterAddressFamily causes NDIS to call the ProtocolCoAfRegisterNotify function of each connection-oriented client on the binding (as shown in two previous figures).

ProtocolCoAfRegisterNotify examines the address-family data to determine whether the client can use the services of this particular CM or MCM driver. Whether the client can make modifications in the (M)CM-supplied address-family data depends on the particular signaling-protocol support of the call manager or MCM driver.

If the client finds the offered call-management services acceptable, ProtocolCoAfRegisterNotify allocates a per-AF context area for the client and calls NdisClOpenAddressFamilyEx. NdisClOpenAddressFamilyEx does not register the client's connection-oriented entry points with NDIS. For more information about registering connection-oriented entry points with NDIS, see CoNDIS Registration.

The call to NdisClOpenAddressFamilyEx causes NDIS to call the call manager's or MCM driver's ProtocolCmOpenAf function (as shown already in the two earlier figures). ProtocolCmOpenAf ensures that the client passed in a valid address family and allocates and initializes the resources necessary to perform operations on behalf of the client that is opening this instance of the address family. ProtocolCmOpenAf also stores an NDIS-supplied NdisAfHandle that represents the association between the call manager and client for the open address family.

ProtocolCmOpenAf can complete synchronously or asynchronously. To complete asynchronously, the ProtocolCmOpenAf function of a call manager calls NdisCmOpenAddressFamilyComplete; the ProtocolCmOpenAf function of an MCM driver calls NdisMCmOpenAddressFamilyComplete. The call to Ndis(M)CmOpenAddressFamilyComplete causes NDIS to call the ProtocolOpenAfComplete function of the client that originally called NdisClOpenAddressFamilyEx.

If the client's call to NdisClOpenAddressFamilyEx is successful, NDIS returns to the client an NdisAfHandle that represents the association between the call manager and client for the open address family.

If a client accepts incoming calls, it usually registers one or more SAPs from its ProtocolClOpenAfCompleteEx function by calling NdisClRegisterSap following its successful call to NdisClOpenAddressFamilyEx.

If a client makes outgoing calls, it could create one or more VCs in its ProtocolClOpenAfCompleteEx function in anticipation of a request by one or more its clients to make an outgoing call.