File: Types.pm

package info (click to toggle)
libpoex-types-perl 1.100910-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 112 kB
  • ctags: 1
  • sloc: perl: 94; makefile: 2
file content (196 lines) | stat: -rw-r--r-- 3,558 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
package POEx::Types;
$POEx::Types::VERSION = '1.100910';
use warnings;
use strict;

#ABSTRACT: Exported Types for use within POEx modules


use POE;
use MooseX::Types -declare => 
[ 
    'Driver', 
    'Filter', 
    'Wheel', 
    'WheelID', 
    'Kernel', 
    'SessionID', 
    'SessionAlias', 
    'Session', 
    'DoesSessionInstantiation',
    'SessionRefIdAliasInstantiation'
];
use MooseX::Types::Moose('Int', 'Str');
use MooseX::Types::Structured('Dict');

class_type 'POE::Kernel';
class_type 'POE::Session';
class_type 'POE::Wheel';
class_type 'POE::Filter';
class_type 'POE::Driver';


subtype Kernel,
    as 'POE::Kernel';


subtype Wheel,
    as 'POE::Wheel';


subtype Filter,
    as 'POE::Filter';


subtype Driver,
    as 'POE::Driver';


subtype Session,
    as 'POE::Session';


subtype SessionID,
    as Int,
    where { $_ > 0 },
    message { 'Something is horribly wrong with the SessionID.' };


subtype SessionAlias,
    as Str;


subtype DoesSessionInstantiation,
    as 'Moose::Object',
    where { $_->does('POEx::Role::SessionInstantiation') };


subtype SessionRefIdAliasInstantiation,
    as Session|SessionID|SessionAlias|DoesSessionInstantiation;


subtype WheelID,
    as Int,
    where { $_ > 0 },
    message { 'Something is horribly wrong with WheelID.' };



coerce SessionID,
    from SessionAlias,
        via { $poe_kernel->alias_resolve($_)->ID },
    from Session,
        via { $_->ID },
    from DoesSessionInstantiation,
        via { $_->ID };


coerce SessionAlias,
    from SessionID,
        via { ($poe_kernel->alias_list($_))[0]; },
    from Session,
        via { ($poe_kernel->alias_list($_))[0]; },
    from DoesSessionInstantiation,
        via { $_->alias; };


coerce Session,
    from SessionID,
        via { $poe_kernel->ID_id_to_session($_) },
    from SessionAlias,
        via { $poe_kernel->alias_resolve($_) };

1;



=pod

=head1 NAME

POEx::Types - Exported Types for use within POEx modules

=head1 VERSION

version 1.100910

=head1 DESCRIPTION

This modules exports the needed subtypes, and coercions for POEx modules
and is based on Sub::Exporter, so see that module for options on importing.

=head1 TYPES

=head2 Kernel

A subtype for POE::Kernel.

=head2 Wheel

A subtype for POE::Wheel.

=head2 Filter

A subtype for POE::Filter.

=head2 Driver

A subtype for POE::Driver.

=head2 Session

This sets an isa constraint on POE::Session

=head2 SessionID

Session IDs in POE are represented as positive integers and this Type 
constrains as such

=head2 SessionAlias

Session aliases are strings in and this is simply an alias for Str

=head2 DoesSessionInstantiation

This sets a constraint for an object that does
POEx::Role::SessionInstantiation

=head2 SessionRefIdAliasInstantiation

This is a convience type that checks for the above types in one go.

=head2 WheelID

WheelIDs are represented as positive integers

=head1 COERCIONS

=head2 SessionID

You can coerce SessionAlias, Session, and DoesSessionInstantiation to a 
SessionID (via to_SessionID)

=head2 SessionAlias

You can also coerce a SessionAlias from a SessionID, Session, or DoesSessionInstantiation
(via to_SessionAlias)

=head2 Session

And finally a Session can be coerced from a SessionID, or SessionAlias (via to_Session)

=head1 AUTHOR

  Nicholas Perez <nperez@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Nicholas Perez.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut


__END__