BSDDirNodeRep.h   [plain text]

/*
 * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
 
/*!
 *  @header CNSLDirNode
 */


#ifndef _NISDirNodeRep_
#define _NISDirNodeRep_	1

#include <stdio.h>
#include <unistd.h>		// for _POSIX_THREADS
#include <pthread.h>	// for pthread_*_t

#include <CoreFoundation/CoreFoundation.h>
#include <DirectoryService/DirServicesTypes.h>
#include <DirectoryServiceCore/CBuff.h>
#include <DirectoryServiceCore/CDataBuff.h>
#include <DirectoryServiceCore/CAttributeList.h>
#include <DirectoryServiceCore/CDSServerModule.h>
#include <DirectoryServiceCore/SharedConsts.h>
#include <DirectoryServiceCore/PluginData.h>

class BSDPlugin;
class NISRecordLookupThread;
class BSDResult;

class BSDDirNodeRep
{
public:
                                BSDDirNodeRep				( BSDPlugin* parent, const void* ref );
                                ~BSDDirNodeRep				( void );
            
			void				DeleteSelf					( void );
            void				Initialize					( CFStringRef nodeNameRef, uid_t uid );
            sInt32 				Initialize					( const char* nodeNamePtr, uid_t uid );
            Boolean				IsInitialized				( void ) { return mInitialized; }	// returns whether this object has been initialized
            Boolean				IsLookupStarted				( void ) { return mLookupStarted; }
            void				LookupHasStarted			( void ) { mLookupStarted = true; }
            void				ResetLookupHasStarted		( void ) { mLookupStarted = false; }
            
			Boolean				IsTopLevelNode				( void );
            CFStringRef			GetNodeName					( void ) { return mNodeName; }
			Boolean				IsFFNode					( void ) { return mIsFFNode; }
            uid_t				GetUID						( void ) { return mUID; }
            void				LimitRecSearch				( unsigned long searchLimit ) { mRecSearchLimit = searchLimit; }
            Boolean				HaveResults					( void );
            
            void				NeedToRedoLastResult		( void )	{ mCurrentIndex--; }
    const 	BSDResult*			GetResult					( CFIndex index );		// 0 based

            void				AddService					( BSDResult* newResult );
            
            void				ResultListQueueLock			( void ) { pthread_mutex_lock( &mResultListQueueLock ); }
            void				ResultListQueueUnlock		( void ) { pthread_mutex_unlock( &mResultListQueueLock ); }
            void				SearchListQueueLock			( void ) { pthread_mutex_lock( &mSearchListQueueLock ); }
            void				SearchListQueueUnlock		( void ) { pthread_mutex_unlock( &mSearchListQueueLock ); }
			
			void				Retain						( void ) { mRefCounter++; }
			void				Release						( void ) { if ( --mRefCounter == 0 ) DeleteSelf(); }
protected:
            
private:
            pthread_mutex_t			mResultListQueueLock;
            pthread_mutex_t			mSearchListQueueLock;
            CFStringRef				mNodeName;
			Boolean					mIsFFNode;
            uid_t					mUID;
            BSDPlugin*				mParentPlugin;
    const	void*					mRef;						// this corresponds to the key mapping to this lookup
            CFIndex					mRecSearchLimit;
            CFMutableArrayRef		mResultList;	
            CFIndex					mCurrentIndex;
            Boolean					mInitialized;
			Boolean					mDeleteSelfWhenDone;
            Boolean					mLookupStarted;
            UInt32					mDelCounter;
			UInt32					mRefCounter;
			BSDDirNodeRep*			mSelfPtr;
};


#endif // #ifndef