HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
expiryNotifier.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_TF_EXPIRY_NOTIFIER_H
25 #define PXR_BASE_TF_EXPIRY_NOTIFIER_H
26 
27 /// \file tf/expiryNotifier.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/arch/hints.h"
31 #include "pxr/base/tf/api.h"
32 
34 
35 /// \class Tf_ExpiryNotifier
36 ///
37 /// Set the extra notifier function.
38 ///
39 /// Objects derived from \c TfWeakBase can request that extra notification be
40 /// performed when they expire. Objects that do not request extra
41 /// notification do not suffer any performance penalty when they expire, while
42 /// objects that request the notification will have the extra notifier
43 /// function run on them, with the address returned by \c
44 /// TfWeakPtr::GetUniqueIdentifier() passed to the notifier function.
45 ///
46 /// An object requests extra notification be performed by calling \c
47 /// wp.RequestExtraNotification() where \c wp is a \c TfWeakPtr pointing to
48 /// the object in question.
49 ///
50 /// This functions sets the extra notifier function to \p func. At present,
51 /// this notifier is intended to be used only by the scripting system to
52 /// inform the system that a particular object has expired and scripting
53 /// resources devoted to that object can be discarded. Accordingly, if
54 /// \p func is non-NULL and a previous non-NULL notifier function has been
55 /// set, a fatal error is issued.
57 public:
58  TF_API static void Invoke(void const *p);
59  TF_API static void SetNotifier(void (*func)(void const *));
60 
61  TF_API static void Invoke2(void const *p);
62  TF_API static void SetNotifier2(void (*func)(void const *));
63 private:
64 
65  static void (*_func)(void const *);
66  static void (*_func2)(void const *);
67 };
68 
70 
71 #endif
#define TF_API
Definition: api.h:40
static TF_API void SetNotifier2(void(*func)(void const *))
void
Definition: png.h:1083
static TF_API void Invoke2(void const *p)
GLfloat GLfloat p
Definition: glew.h:16321
GLenum func
Definition: glcorearb.h:782
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static TF_API void Invoke(void const *p)
static TF_API void SetNotifier(void(*func)(void const *))