summaryrefslogtreecommitdiff
path: root/xpp/perl_modules/Dahdi.pm
diff options
context:
space:
mode:
Diffstat (limited to 'xpp/perl_modules/Dahdi.pm')
-rw-r--r--xpp/perl_modules/Dahdi.pm68
1 files changed, 68 insertions, 0 deletions
diff --git a/xpp/perl_modules/Dahdi.pm b/xpp/perl_modules/Dahdi.pm
new file mode 100644
index 0000000..a191556
--- /dev/null
+++ b/xpp/perl_modules/Dahdi.pm
@@ -0,0 +1,68 @@
+package Dahdi;
+#
+# Written by Oron Peled <oron@actcom.co.il>
+# Copyright (C) 2007, Xorcom
+# This program is free software; you can redistribute and/or
+# modify it under the same terms as Perl itself.
+#
+# $Id$
+#
+use strict;
+use Dahdi::Span;
+
+=head1 NAME
+
+Dahdi - Perl interface to Dahdi information
+
+This package allows access from Perl to information about Dahdi
+hardware and loaded Dahdi devices.
+
+=head1 SYNOPSIS
+
+ # Listing channels in analog spans:
+ use Dahdi;
+ # scans system:
+ my @xbuses = Dahdi::spans();
+ for my $span (@spans) {
+ next if ($span->is_digital);
+ $span->num. " - [". $span->type ."] ". $span->name. "\n";
+ for my $chan ($span->chans) {
+ print " - ".$chan->num . " - [". $chan->type. "] ". $chan->fqn". \n";
+ }
+ }
+=cut
+
+my $proc_base = "/proc/dahdi";
+
+=head1 spans()
+
+Returns a list of span objects, ordered by span number.
+
+=cut
+
+sub spans() {
+ my @spans;
+
+ -d $proc_base or return ();
+ foreach my $zfile (glob "$proc_base/*") {
+ $zfile =~ s:$proc_base/::;
+ my $span = Dahdi::Span->new($zfile);
+ push(@spans, $span);
+ }
+ @spans = sort { $a->num <=> $b->num } @spans;
+ return @spans;
+}
+
+=head1 SEE ALSO
+
+Span objects: L<Dahdi::Span>.
+
+Dahdi channels objects: L<Dahdi::Chan>.
+
+Dahdi hardware devices information: L<Dahdi::Hardware>.
+
+Xorcom Astribank -specific information: L<Dahdi::Xpp>.
+
+=cut
+
+1;