windows-server-2003/net/sockets/winsock2/ws2_32/inc/nscatent.h

/*++


    Intel Corporation Proprietary Information
    Copyright (c) 1995 Intel Corporation

    This listing is supplied under the terms of a license agreement with
    Intel Corporation and may not be used, copied, nor disclosed except in
    accordance with the terms of that agreeement.


Module Name:

    nscatent.h

Abstract:

    This  file  contains the class definition for the NSCATALOGENTRY class.
    This  class  defines the interface to the entries that can be installed and
    retrieved in the namespace provider catalog.

Author:
    Dirk Brandewie (dirk@mink.intel.com)  09-Nov-1995

Notes:

    $Revision:   1.9  $

    $Modtime:   15 Feb 1996 16:13:18  $

Revision History:

    09-Nov-1995  dirk@mink.intel.com
        Initial Revision

--*/

#ifndef _NSCATENT_
#define _NSCATENT_

#include "winsock2.h"
#include <windows.h>


class NSCATALOGENTRY {
public:

    NSCATALOGENTRY();

    INT
    InitializeFromRegistry(
        IN  HKEY  ParentKey,
        IN  INT   SequenceNum
        );

    INT
    InitializeFromValues(
        IN  LPWSTR            LibraryPath,
        IN  LPWSTR            DisplayString,
        IN  LPGUID            ProviderId,
        IN  DWORD             NameSpaceId,
        IN  DWORD             Version
        );

    PNSPROVIDER
    GetProvider();

    LPGUID
    GetProviderId();

    DWORD
    GetNamespaceId();

    LONG
    GetAddressFamily();

    LPWSTR
    GetLibraryPath();

    VOID
    SetVersion(
        IN DWORD Version
        );

    DWORD
    GetVersion();

    BOOL
    GetEnabledState();

    BOOL
    StoresServiceClassInfo();

    LPWSTR
    GetProviderDisplayString();

    INT
    WriteToRegistry(
        IN  HKEY  ParentKey,
        IN  INT   SequenceNum
        );

    VOID
    Enable(
        IN BOOLEAN EnableValue
        );

    VOID
    Reference (
        );
    VOID
    Dereference (
        );
private:

    // Should never be called directly but through dereferencing
    ~NSCATALOGENTRY();

friend class NSCATALOG; // So it can access some of the private
                        // fields and methods below.

    VOID
    SetProvider (
        IN PNSPROVIDER  Provider
        );

    INT
    IoRegistry(
        IN  HKEY  EntryKey,
        IN  BOOL  IsRead);

    LIST_ENTRY     m_CatalogLinkage;
    // Used  to  link  items  in  catalog.   Note  that  this particular member
    // variable  is in the public section to make it available for manipulation
    // by the catalog object.

    LONG        m_reference_count;
    // How many time this structure was referenced

    PNSPROVIDER  m_provider;
    // Pointer to the dprovider object attached to this catalog entry.

    DWORD m_namespace_id;
    // The name space supported by this provider

    LONG m_address_family;
    // the address family it supports

    DWORD m_version;
    // The version supported by this provider

    BOOLEAN m_enabled;
    // Is this provider enabled / should it be returned by
    // WSAEnumNameSpaceProviders

    BOOLEAN m_stores_service_class_info;
    // Does this provider store service class info information

    LPWSTR m_providerDisplayString;
    // The human readable string describing this provider

    GUID m_providerId;
    // The GUID for this provider

    WCHAR m_LibraryPath[MAX_PATH];
    // Fully qualified path to the provider's DLL image.

};  // class NSCATALOGENTRY


inline
VOID
NSCATALOGENTRY::Reference () {
    //
    // Object is created with reference count of 1
    // and is destroyed whenever it gets back to 0.
    //
    assert (m_reference_count>0);
    InterlockedIncrement (&m_reference_count);
}


inline
VOID
NSCATALOGENTRY::Dereference () {
    assert (m_reference_count>0);
    if (InterlockedDecrement (&m_reference_count)==0)
        delete this;
}


inline
PNSPROVIDER
NSCATALOGENTRY::GetProvider()
/*++

Routine Description:

    This  procedure  retrieves  a reference to the NSPROVIDER associated with a
    catalog  entry. 

Arguments:

    None

Return Value:

    Returns  the  current  provider  reference,  or  NULL if provider is not
    loaded yet
--*/
{
    return(m_provider);
}  // GetProvider


inline LPGUID
NSCATALOGENTRY::GetProviderId(
    )
/*++

Routine Description:

    This function returns a pointer to the provider ID sored in this object.

Arguments:

    NONE

Return Value:

    The address of m_providerId.

--*/
{
    return(&m_providerId);
}



inline LONG
NSCATALOGENTRY::GetAddressFamily(
    )
/*++

Routine Description:

    Returns the Address family of the namespace supported by this provider.

Arguments:

    NONE

Return Value:

    The value of m_address_family.

--*/
{
    return(m_address_family);
}



inline DWORD
NSCATALOGENTRY::GetNamespaceId(
    )
/*++

Routine Description:

    Returns the ID of the namespace supported by this provider.

Arguments:

    NONE

Return Value:

    The value of m_namespace_id.

--*/
{
    return(m_namespace_id);
}



inline DWORD
NSCATALOGENTRY::GetVersion()
/*++

Routine Description:

    Returns the version supported by this namespace provider.

Arguments:

    NONE

Return Value:

    The value of m_version.

--*/
{
    return(m_version);
}


inline LPWSTR
NSCATALOGENTRY::GetLibraryPath()
/*++

Routine Description:

    Returns library path of the provider

Arguments:

    NONE

Return Value:

    The value of m_LibraryPath.

--*/
{
    return(m_LibraryPath);
}


inline BOOL
NSCATALOGENTRY::GetEnabledState(
    )
/*++

Routine Description:

    Returns the enabled state of the provider.

Arguments:

    NONE

Return Value:

    The value of m_enabled.

--*/
{
    return(m_enabled);
}


inline LPWSTR
NSCATALOGENTRY::GetProviderDisplayString(
    )
/*++

Routine Description:

    Returns the display string of the provider.

Arguments:

    NONE

Return Value:

    The value of m_providerDisplayString;

--*/
{
    return(m_providerDisplayString);
}


inline BOOL
NSCATALOGENTRY::StoresServiceClassInfo()
/*++

Routine Description:

    Returns whether the provider stores service class infomation.

Arguments:

    NONE

Return Value:

   The value of m_stores_service_class_info.

--*/
{
    return(m_stores_service_class_info);
}


#endif // _NSCATENT_