2 # module to manage channel lists & data
4 # This is the base class for all channel operations, which is everything to do
5 # with input and output really.
7 # The instance variable in the outside world will be generally be called $dxchann
9 # This class is 'inherited' (if that is the goobledegook for what I am doing)
10 # by various other modules. The point to understand is that the 'instance variable'
11 # is in fact what normal people would call the state vector and all useful info
12 # about a connection goes in there.
14 # Another point to note is that a vector may contain a list of other vectors.
15 # I have simply added another variable to the vector for 'simplicity' (or laziness
16 # as it is more commonly called)
18 # PLEASE NOTE - I am a C programmer using this as a method of learning perl
19 # firstly and OO about ninthly (if you don't like the design and you can't
20 # improve it with better OO by make it smaller and more efficient, then tough).
22 # Copyright (c) 1998 - Dirk Koopman G1TLH
35 use vars qw(%channels %valid);
41 conn => '9,Msg Conn ref',
42 user => '9,DXUser ref',
43 startt => '0,Start Time,atime',
45 pc50_t => '9,Last PC50 Time,atime',
46 priv => '9,Privilege',
47 state => '0,Current State',
48 oldstate => '5,Last State',
49 list => '9,Dep Chan List',
50 name => '0,User Name',
51 consort => '9,Connection Type',
52 sort => '9,Type of Channel',
53 wwv => '0,Want WWV,yesno',
54 talk => '0,Want Talk,yesno',
55 ann => '0,Want Announce,yesno',
56 here => '0,Here?,yesno',
57 confmode => '0,In Conference?,yesno',
58 dx => '0,DX Spots,yesno',
59 redirect => '0,Redirect messages to',
62 loc => '9,Local Vars', # used by func to store local variables in
65 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
68 my ($pkg, $call, $conn, $user) = @_;
71 die "trying to create a duplicate channel for $call" if $channels{$call};
72 $self->{call} = $call;
73 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
74 $self->{user} = $user if defined $user;
75 $self->{startt} = $self->{t} = time;
77 $self->{oldstate} = 0;
79 return $channels{$call} = $self;
82 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
85 my ($pkg, $call) = @_;
86 return $channels{$call};
89 # obtain all the channel objects
93 return values(%channels);
96 # obtain a channel object by searching for its connection reference
99 my ($pkg, $conn) = @_;
102 foreach $self (values(%channels)) {
103 return $self if ($self->{conn} == $conn);
108 # get rid of a channel object [$obj->del()]
112 delete $channels{$self->{call}};
115 # is it an ak1a cluster ?
119 return $self->{sort} eq 'A';
126 return $self->{sort} eq 'U';
129 # is it a connect type
133 return $self->{sort} eq 'C';
136 # handle out going messages, immediately without waiting for the select to drop
137 # this could, in theory, block
141 my $conn = $self->{conn};
143 my $call = $self->{call};
148 dbg('chan', "-> $sort $call $line\n") if $conn;
149 $conn->send_now("$sort$call|$line") if $conn;
155 # the normal output routine
157 sub send # this is always later and always data
160 my $conn = $self->{conn};
161 my $call = $self->{call};
166 dbg('chan', "-> D $call $line\n") if $conn;
167 $conn->send_later("D$call|$line") if $conn;
172 # send a file (always later)
175 my ($self, $fn) = @_;
176 my $call = $self->{call};
177 my $conn = $self->{conn};
180 open(F, $fn) or die "can't open $fn for sending file ($!)";
186 # this will implement language independence (in time)
193 # change the state of the channel - lots of scope for debugging here :-)
198 $self->{oldstate} = $self->{state};
199 $self->{state} = shift;
200 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
202 return $self->{state};
205 # disconnect this channel
209 my $user = $self->{user};
210 my $conn = $self->{conn};
212 $user->close() if defined $user;
213 $conn->disconnect() if defined $conn;
217 # various access routines
220 # return a list of valid elements
229 # return a prompt for a field
234 my ($self, $ele) = @_;
242 my $name = $AUTOLOAD;
243 return if $name =~ /::DESTROY$/;
246 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
247 @_ ? $self->{$name} = shift : $self->{$name} ;