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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
package Net::Route;
use 5.008;
use Moose;
use version; our $VERSION = qv( 'v0.02' );
use NetAddr::IP;
has 'destination' => ( is => 'ro', required => 1, isa => 'NetAddr::IP' );
has 'gateway' => ( is => 'ro', required => 1, isa => 'NetAddr::IP' );
has 'metric' => ( is => 'ro', required => 1, isa => 'Int' );
has 'interface' => ( is => 'ro', required => 1, isa => 'Str' );
has 'is_active' => ( is => 'ro', required => 1, );
has 'is_dynamic' => ( is => 'ro', required => 1, );
no Moose;
__PACKAGE__->meta->make_immutable();
1;
__END__
=head1 NAME
Net::Route - Portable interface to the routing table
=head1 SYNOPSIS
use Net::Route::Table;
my $table_ref = Net::Route::Table->from_system();
my $route_ref = $table_ref->default_route();
print "Default gateway: ", $route_ref->gateway(), "\n";
=head1 VERSION
Version 0.02, $Revision: 372 $
=head1 DESCRIPTION
=head2 The Net::Route Module
Every OS provides its custom interface to the routing table: Linux' C<route>
utility is different from BSD's C<route show>, from Windows' C<route print>,
etc. Parsing all these different output styles in an (otherwise portable)
script can quickly become inconvenient.
L<Net::Route> abstracts the system specifics and provides a single, portable
interface.
=head2 The Net::Route Class
L<Net::Route> objects represent single entries from a L<Net::Route::Table>.
=head1 INTERFACE
This documents L<Net::Route> as a class. To know how to use the module, refer
to the L<synopsis|/SYNOPSIS> or L<Net::Route::Table> (the entry point from a
user perspective).
=head2 Object Methods
=head3 destination()
=head3 gateway()
=head3 metric()
=head3 interface()
=head3 is_active()
=head3 is_dynamic()
=head1 INSTALLING DEPENDENCIES ON SUN SOLARIS SYSTEMS WITH GCC
The perl interpreter shipped with Solaris was compiled with Sun's proprietary C
compiler, and therefore attempts to compile XS modules with the same tool and
options. However, Solaris comes by default with the GNU C Compiler (C<gcc>)
only, which has its own set of incompatible command-line arguments. Mixing
these two to compile C<XS> Perl modules doesn't work.
Therefore, when you need to install CPAN modules (such as L<Net::Route>'s
dependencies) which make use of C<XS> (C code) on a system without the Sun C
Compiler, you have to use the wrapper script provided by Sun which will invoke
C<gcc> correctly (replace C<Module> as needed):
/usr/perl5/bin/perlgcc -MCPAN -e 'install Module'.
=head1 STATUS AND ROADMAP
Please refer to the Changes file for a detailed history.
=head2 0.01 - First Public Release
L<Net::Route> meets our goals for a first public release:
=over
=item *
It can list all routes
=item *
It can get the default route
=item *
It can provide the most common characteristics of routes
=item *
It is portable on Linux, Solaris and Windows
=back
L<Net::Route> is used in other
Straton IT (L<http://en.straton-it.fr/>) software, such as
Cancerbero 0.7 (L<http://en.straton-it.fr/open-source/cancerbero-07>) and
Confdump/Sys (L<http://confdump.sourceforge.net/>).
=head2 0.xx - Community Releases
These releases will include features and bugfixes suggested, reported and/or
contributed by the community. For example:
=over
=item *
Differentiating between C<Net::Route>-as-a-class and C<Net::Route>-as-a-module
=item *
Support for more operating systems
=item *
Getting rid of CPAN dependencies that are troublesome to install on some
platforms.
=item *
Your idea (L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Route>) here...
=back
The API might change somewhat, if necessary.
=head2 1.0 - API Freeze
When appropriate (according to the user reports), we will freeze the interface
and release version 1.0.
=head1 BUGS
Please report any bugs or feature requests to C<bug-net-route at rt.cpan.org>,
or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Route>. I will be
notified, and then you'll automatically be notified of progress on your bug as
I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Net::Route
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Route>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Net-Route>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Net-Route>
=item * Search CPAN
L<http://search.cpan.org/dist/Net-Route>
=back
=head1 AUTHOR
Created by Alexandre Storoz, C<< <astoroz@straton-it.fr> >>
Maintained by Thomas Equeter, C<< <tequeter@straton-it.fr> >>
=head1 LICENSE AND COPYRIGHT
Copyright (C) 2009 Straton IT.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
|
