1POE::Resource(3)      User Contributed Perl Documentation     POE::Resource(3)
2
3
4

NAME

6       POE::Resource - internal resource managers for POE::Kernel
7

SYNOPSIS

9       Varies, although most POE::Resource subclasses do not have public APIs.
10

DESCRIPTION

12       POE manages several types of information internally.  Its Resource
13       classes are mix-ins designed to manage those types of information
14       behind tidy, mostly private interfaces.  This was done to facilitate
15       testing and a conversion to C without the need to port POE::Kernel all
16       at once.
17
18       POE::Resource subclasses are generally different from one another, but
19       there are some similarities to note.
20
21       Every resource should have an initializer and finalizer method.
22       Initializers set up initial data and link resources into POE::Kernel.
23       Finalizers clean up any remaining data and verify that each resource
24       subsystem was left in a consistent state.
25
26       One common theme in resource implementations is that they don't need to
27       perform much error checking, if any.  Resource methods are used
28       internally by POE::Kernel and/or POE::API classes, so it's up to them
29       to ensure correct usage.
30
31       Resource methods follow the naming convention _data_???_activity, where
32       ??? is an abbreviation for the type of resource it belongs to:
33
34         POE::Resource::Events      _data_ev_initialize
35         POE::Resource::FileHandles _data_handle_initialize
36         POE::Resource::Signals     _data_sig_initialize
37
38       Finalizer methods end in "_finalize".
39
40         _data_ev_finalize
41         _data_handle_finalize
42         _data_sig_finalize
43
44       Finalizers return true if a resource shut down cleanly, or false if
45       there were inconsistencies or leaks during end-of-run checking.  The
46       t/res/*.t tests rely on these return values.
47

SEE ALSO

49       POE::Resource::Aliases, POE::Resource::Events, POE::Resource::Extrefs,
50       POE::Resource::FileHandles, POE::Resource::SIDs,
51       POE::Resource::Sessions, POE::Resource::Signals
52
53       Also see "Resources" in POE::Kernel for public information about POE
54       resources.
55

BUGS

57       None known.
58

AUTHORS & LICENSING

60       Please see POE for more information about its authors, contributors,
61       and licensing.
62
63
64
65perl v5.36.0                      2023-01-20                  POE::Resource(3)