src/perlmods/OpenSRF/AppSession.pm

   1 package OpenSRF::AppSession;
   2 use OpenSRF::DOM;
   3 #use OpenSRF::DOM::Element::userAuth;
   4 use OpenSRF::DomainObject::oilsMessage;
   5 use OpenSRF::DomainObject::oilsMethod;
   6 use OpenSRF::DomainObject::oilsResponse qw/:status/;
   7 use OpenSRF::Transport::PeerHandle;
   8 use OpenSRF::Utils::Logger qw(:level);
   9 use OpenSRF::Utils::SettingsClient;
  10 use OpenSRF::Utils::Config;
  11 use OpenSRF::EX;
  12 use OpenSRF;
  13 use Exporter;
  14 use base qw/Exporter OpenSRF/;
  15 use Time::HiRes qw( time usleep );
  16 use warnings;
  17 use strict;
  18
  19 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
  20 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
  21                  endpoint => [ qw/CLIENT SERVER/ ],
  22 );
  23
  24 my $logger = "OpenSRF::Utils::Logger";
  25
  26 our %_CACHE;
  27 our @_CLIENT_CACHE;
  28 our @_RESEND_QUEUE;
  29
  30 sub kill_client_session_cache {
  31         for my $session ( @_CLIENT_CACHE ) {
  32                 $session->kill_me;
  33         }
  34 }
  35
  36 sub CONNECTING { return 3 };
  37 sub INIT_CONNECTED { return 4 };
  38 sub CONNECTED { return 1 };
  39 sub DISCONNECTED { return 2 };
  40
  41 sub CLIENT { return 2 };
  42 sub SERVER { return 1 };
  43
  44 sub find {
  45         return undef unless (defined $_[1]);
  46         return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
  47 }
  48
  49 sub find_client {
  50         my( $self, $app ) = @_;
  51         $logger->debug( "Client Cache contains: " .scalar(@_CLIENT_CACHE), INTERNAL );
  52         my ($client) = grep { $_->[0] eq $app and $_->[1] == 1 } @_CLIENT_CACHE;
  53         $client->[1] = 0;
  54         return $client->[2];
  55 }
  56
  57 sub transport_connected {
  58         my $self = shift;
  59         if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
  60                 return 0;
  61         }
  62         return $self->{peer_handle}->tcp_connected();
  63 }
  64
  65 # ----------------------------------------------------------------------------
  66 # Clears the transport buffers
  67 # call this if you are not through with the sesssion, but you want
  68 # to have a clean slate.  You shouldn't have to call this if
  69 # you are correctly 'recv'ing all of the data from a request.
  70 # however, if you don't want all of the data, this will
  71 # slough off any excess
  72 #  * * Note: This will delete data for all sessions using this transport
  73 # handle.  For example, all client sessions use the same handle.
  74 # ----------------------------------------------------------------------------
  75 sub buffer_reset {
  76
  77         my $self = shift;
  78         if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
  79                 return 0;
  80         }
  81         $self->{peer_handle}->buffer_reset();
  82 }
  83
  84
  85 sub client_cache {
  86         my $self = shift;
  87         push @_CLIENT_CACHE, [ $self->app, 1, $self ];
  88 }
  89
  90 # when any incoming data is received, this method is called.
  91 sub server_build {
  92         my $class = shift;
  93         $class = ref($class) || $class;
  94
  95         my $sess_id = shift;
  96         my $remote_id = shift;
  97         my $service = shift;
  98
  99         return undef unless ($sess_id and $remote_id and $service);
 100
 101         my $config_client = OpenSRF::Utils::SettingsClient->new();
 102
 103         if ( my $thingy = $class->find($sess_id) ) {
 104                 $thingy->remote_id( $remote_id );
 105                 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
 106                 return $thingy;
 107         } else {
 108                 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
 109         }
 110
 111         if( $service eq "client" ) {
 112                 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
 113                 #       " Session ID [$sess_id], remote_id [$remote_id]");
 114                 $logger->debug("Attempting to build a client session as ".
 115                                 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
 116         }
 117
 118
 119         #my $max_requests = $conf->$service->max_requests;
 120         my $max_requests        = $config_client->config_value("apps",$service,"max_requests");
 121         $logger->debug( "Max Requests for $service is $max_requests", INTERNAL );# if $max_requests;
 122
 123         $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
 124
 125         my $self = bless { recv_queue  => [],
 126                            request_queue  => [],
 127                            requests  => 0,
 128                            endpoint    => SERVER,
 129                            state       => CONNECTING,
 130                            session_id  => $sess_id,
 131                            remote_id    => $remote_id,
 132                                 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
 133                                 max_requests => $max_requests,
 134                                 session_threadTrace => 0,
 135                                 service => $service,
 136                          } => $class;
 137
 138         return $_CACHE{$sess_id} = $self;
 139 }
 140
 141 sub service { return shift()->{service}; }
 142
 143 sub continue_request {
 144         my $self = shift;
 145         $self->{'requests'}++;
 146         return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
 147 }
 148
 149 sub last_sent_payload {
 150         my( $self, $payload ) = @_;
 151         if( $payload ) {
 152                 return $self->{'last_sent_payload'} = $payload;
 153         }
 154         return $self->{'last_sent_payload'};
 155 }
 156
 157 sub last_sent_type {
 158         my( $self, $type ) = @_;
 159         if( $type ) {
 160                 return $self->{'last_sent_type'} = $type;
 161         }
 162         return $self->{'last_sent_type'};
 163 }
 164
 165 sub get_app_targets {
 166         my $app = shift;
 167
 168         my $targets;
 169         my $config_client = OpenSRF::Utils::SettingsClient->new();
 170
 171         if( $app eq "settings" ) { # we have to load from the bootstrap config file
 172
 173                 my $conf = OpenSRF::Utils::Config->current;
 174                 if(!$conf) { die("No transport target for $app!"); }
 175                 $targets = $conf->targets->$app || die("No transport target for $app!");
 176
 177         } else {
 178                 $targets =  $config_client->config_value("apps",$app,"transport_targets", "router_target");
 179                 if( !ref($targets) ) { $targets = [ $targets ]; }
 180         }
 181
 182         return @$targets;
 183 }
 184
 185 # When we're a client and we want to connect to a remote service
 186 # create( $app, username => $user, secret => $passwd );
 187 #    OR
 188 # create( $app, sysname => $user, secret => $shared_secret );
 189 sub create {
 190         my $class = shift;
 191         $class = ref($class) || $class;
 192
 193         my $app = shift;
 194
 195         if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
 196                         $logger->debug( "AppSession returning existing client session for $app", DEBUG );
 197                         return $thingy;
 198         } else {
 199                 $logger->debug( "AppSession creating new client session for $app", DEBUG );
 200         }
 201
 202
 203         my $sess_id = time . rand( $$ );
 204         while ( $class->find($sess_id) ) {
 205                 $sess_id = time . rand( $$ );
 206         }
 207
 208         my ($r_id) = get_app_targets($app);
 209
 210         my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
 211         if( ! $peer_handle ) {
 212                 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
 213         }
 214
 215         my $self = bless { app_name    => $app,
 216                                 #client_auth => $auth,
 217                            #recv_queue  => [],
 218                            request_queue  => [],
 219                            endpoint    => CLIENT,
 220                            state       => DISCONNECTED,#since we're init'ing
 221                            session_id  => $sess_id,
 222                            remote_id   => $r_id,
 223                            api_level   => 1,
 224                            orig_remote_id   => $r_id,
 225                                 peer_handle => $peer_handle,
 226                                 session_threadTrace => 0,
 227                          } => $class;
 228
 229         $self->client_cache();
 230         $_CACHE{$sess_id} = $self;
 231         return $self->find_client( $app );
 232 }
 233
 234 sub api_level {
 235         return shift()->{api_level};
 236 }
 237
 238 sub app {
 239         return shift()->{app_name};
 240 }
 241
 242 sub reset {
 243         my $self = shift;
 244         $self->remote_id($$self{orig_remote_id});
 245 }
 246
 247 # 'connect' can be used as a constructor if called as a class method,
 248 # or used to connect a session that has disconnectd if called against
 249 # an existing session that seems to be disconnected, or was just built
 250 # using 'create' above.
 251
 252 # connect( $app, username => $user, secret => $passwd );
 253 #    OR
 254 # connect( $app, sysname => $user, secret => $shared_secret );
 255
 256 # --- Returns undef if the connect attempt times out.
 257 # --- Returns the OpenSRF::EX object if one is returned by the server
 258 # --- Returns self if connected
 259 sub connect {
 260         my $self = shift;
 261         my $class = ref($self) || $self;
 262
 263         if ( ref( $self ) and  $self->state && $self->state == CONNECTED  ) {
 264                 $logger->transport("ABC AppSession already connected", DEBUG );
 265         } else {
 266                 $logger->transport("ABC AppSession not connected, connecting..", DEBUG );
 267         }
 268         return $self if ( ref( $self ) and  $self->state && $self->state == CONNECTED  );
 269
 270         my $app = shift;
 271         my $api_level = shift;
 272         $api_level = 1 unless (defined $api_level);
 273
 274         $self = $class->create($app, @_) if (!ref($self));
 275         return undef unless ($self);
 276
 277         $self->{api_level} = $api_level;
 278
 279         $self->reset;
 280         $self->state(CONNECTING);
 281         $self->send('CONNECT', "");
 282
 283         # if we want to connect to settings, we may not have
 284         # any data for the settings client to work with...
 285         # just using a default for now XXX
 286
 287         my $time_remaining = 5;
 288
 289 =head blah
 290         my $client = OpenSRF::Utils::SettingsClient->new();
 291         my $trans = $client->config_value("client_connection","transport_host");
 292
 293         if(!ref($trans)) {
 294                 $time_remaining = $trans->{connect_timeout};
 295         } else {
 296                 # XXX for now, just use the first
 297                 $time_remaining = $trans->[0]->{connect_timeout};
 298         }
 299 =cut
 300
 301         while ( $self->state != CONNECTED  and $time_remaining > 0 ) {
 302                 my $starttime = time;
 303                 $self->queue_wait($time_remaining);
 304                 my $endtime = time;
 305                 $time_remaining -= ($endtime - $starttime);
 306         }
 307
 308         return undef unless($self->state == CONNECTED);
 309
 310         return $self;
 311 }
 312
 313 sub finish {
 314         my $self = shift;
 315         if( ! $self->session_id ) {
 316                 return 0;
 317         }
 318         #$self->disconnect if ($self->endpoint == CLIENT);
 319         for my $ses ( @_CLIENT_CACHE ) {
 320                 if ($ses->[2]->session_id eq $self->session_id) {
 321                         $ses->[1] = 1;
 322                 }
 323         }
 324 }
 325
 326 sub kill_me {
 327         my $self = shift;
 328         if( ! $self->session_id ) { return 0; }
 329         $self->disconnect;
 330         $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
 331         my @a;
 332         for my $ses ( @_CLIENT_CACHE ) {
 333                 push @a, $ses
 334                         if ($ses->[2]->session_id ne $self->session_id);
 335         }
 336         @_CLIENT_CACHE = @a;
 337         delete $_CACHE{$self->session_id};
 338         delete($$self{$_}) for (keys %$self);
 339 }
 340
 341 sub disconnect {
 342         my $self = shift;
 343         unless( $self->state == DISCONNECTED ) {
 344                 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
 345                 $self->state( DISCONNECTED );
 346         }
 347         $self->reset;
 348 }
 349
 350 sub request {
 351         my $self = shift;
 352         my $meth = shift;
 353
 354         my $method;
 355         if (!ref $meth) {
 356                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
 357         } else {
 358                 $method = $meth;
 359         }
 360
 361         $method->params( @_ );
 362
 363         $self->send('REQUEST',$method);
 364 }
 365
 366
 367 sub send {
 368         my $self = shift;
 369         my @payload_list = @_; # this is a Domain Object
 370
 371
 372         $logger->debug( "In send", INTERNAL );
 373
 374         my $tT;
 375
 376         if( @payload_list % 2 ) { $tT = pop @payload_list; }
 377
 378         if( ! @payload_list ) {
 379                 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
 380                 return undef;
 381         }
 382
 383         my $doc = OpenSRF::DOM->createDocument();
 384
 385         $logger->debug( "In send2", INTERNAL );
 386
 387         my $disconnect = 0;
 388         my $connecting = 0;
 389
 390         while( @payload_list ) {
 391
 392                 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
 393
 394                 if ($msg_type eq 'DISCONNECT' ) {
 395                         $disconnect++;
 396                         if( $self->state == DISCONNECTED) {
 397                                 next;
 398                         }
 399                 }
 400
 401                 if( $msg_type eq "CONNECT" ) { $connecting++; }
 402
 403
 404                 if( $payload ) {
 405                         $logger->debug( "Payload is ".$payload->toString, INTERNAL );
 406                 }
 407
 408
 409                 my $msg = OpenSRF::DomainObject::oilsMessage->new();
 410                 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
 411
 412                 $msg->type($msg_type);
 413                 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
 414
 415                 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
 416
 417                 no warnings;
 418                 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
 419                 use warnings;
 420
 421                 if ($msg->type eq 'REQUEST') {
 422                         if ( !defined($tT) || $self->last_threadTrace != $tT ) {
 423                                 $msg->update_threadTrace;
 424                                 $self->session_threadTrace( $msg->threadTrace );
 425                                 $tT = $self->session_threadTrace;
 426                                 OpenSRF::AppRequest->new($self, $payload);
 427                         }
 428                 }
 429
 430                 $msg->api_level($self->api_level);
 431                 $msg->payload($payload) if $payload;
 432
 433                 $doc->documentElement->appendChild( $msg );
 434
 435
 436                 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
 437                         " with threadTrace [".$msg->threadTrace."]", INFO );
 438
 439         }
 440
 441         if ($self->endpoint == CLIENT and ! $disconnect) {
 442                 $self->queue_wait(0);
 443                 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
 444                         my $v = $self->connect();
 445                         if( ! $v ) {
 446                                 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
 447                                 return undef;
 448                         }
 449                         if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
 450                                 return $v;
 451                         }
 452                 }
 453         }
 454
 455         $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
 456
 457
 458         $self->{peer_handle}->send(
 459                                         to     => $self->remote_id,
 460                                    thread => $self->session_id,
 461                                    body   => $doc->toString );
 462
 463         return $self->app_request( $tT );
 464 }
 465
 466 sub app_request {
 467         my $self = shift;
 468         my $tT = shift;
 469
 470         return undef unless (defined $tT);
 471         my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
 472
 473         return $req;
 474 }
 475
 476 sub remove_app_request {
 477         my $self = shift;
 478         my $req = shift;
 479
 480         my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
 481
 482         $self->{request_queue} = \@list;
 483 }
 484
 485 sub endpoint {
 486         return $_[0]->{endpoint};
 487 }
 488
 489
 490 sub session_id {
 491         my $self = shift;
 492         return $self->{session_id};
 493 }
 494
 495 sub push_queue {
 496         my $self = shift;
 497         my $resp = shift;
 498         my $req = $self->app_request($resp->[1]);
 499         return $req->push_queue( $resp->[0] ) if ($req);
 500         push @{ $self->{recv_queue} }, $resp->[0];
 501 }
 502
 503 sub last_threadTrace {
 504         my $self = shift;
 505         my $new_last_threadTrace = shift;
 506
 507         my $old_last_threadTrace = $self->{last_threadTrace};
 508         if (defined $new_last_threadTrace) {
 509                 $self->{last_threadTrace} = $new_last_threadTrace;
 510                 return $new_last_threadTrace unless ($old_last_threadTrace);
 511         }
 512
 513         return $old_last_threadTrace;
 514 }
 515
 516 sub session_threadTrace {
 517         my $self = shift;
 518         my $new_last_threadTrace = shift;
 519
 520         my $old_last_threadTrace = $self->{session_threadTrace};
 521         if (defined $new_last_threadTrace) {
 522                 $self->{session_threadTrace} = $new_last_threadTrace;
 523                 return $new_last_threadTrace unless ($old_last_threadTrace);
 524         }
 525
 526         return $old_last_threadTrace;
 527 }
 528
 529 sub last_message_type {
 530         my $self = shift;
 531         my $new_last_message_type = shift;
 532
 533         my $old_last_message_type = $self->{last_message_type};
 534         if (defined $new_last_message_type) {
 535                 $self->{last_message_type} = $new_last_message_type;
 536                 return $new_last_message_type unless ($old_last_message_type);
 537         }
 538
 539         return $old_last_message_type;
 540 }
 541
 542 sub last_message_api_level {
 543         my $self = shift;
 544         my $new_last_message_api_level = shift;
 545
 546         my $old_last_message_api_level = $self->{last_message_api_level};
 547         if (defined $new_last_message_api_level) {
 548                 $self->{last_message_api_level} = $new_last_message_api_level;
 549                 return $new_last_message_api_level unless ($old_last_message_api_level);
 550         }
 551
 552         return $old_last_message_api_level;
 553 }
 554
 555 sub remote_id {
 556         my $self = shift;
 557         my $new_remote_id = shift;
 558
 559         my $old_remote_id = $self->{remote_id};
 560         if (defined $new_remote_id) {
 561                 $self->{remote_id} = $new_remote_id;
 562                 return $new_remote_id unless ($old_remote_id);
 563         }
 564
 565         return $old_remote_id;
 566 }
 567
 568 sub client_auth {
 569         return undef;
 570         my $self = shift;
 571         my $new_ua = shift;
 572
 573         my $old_ua = $self->{client_auth};
 574         if (defined $new_ua) {
 575                 $self->{client_auth} = $new_ua;
 576                 return $new_ua unless ($old_ua);
 577         }
 578
 579         return $old_ua->cloneNode(1);
 580 }
 581
 582 sub state {
 583         my $self = shift;
 584         my $new_state = shift;
 585
 586         my $old_state = $self->{state};
 587         if (defined $new_state) {
 588                 $self->{state} = $new_state;
 589                 return $new_state unless ($old_state);
 590         }
 591
 592         return $old_state;
 593 }
 594
 595 sub DESTROY {
 596         my $self = shift;
 597         delete $$self{$_} for keys %$self;
 598         return undef;
 599 }
 600
 601 sub recv {
 602         my $self = shift;
 603         my @proto_args = @_;
 604         my %args;
 605
 606         if ( @proto_args ) {
 607                 if ( !(@proto_args % 2) ) {
 608                         %args = @proto_args;
 609                 } elsif (@proto_args == 1) {
 610                         %args = ( timeout => @proto_args );
 611                 }
 612         }
 613
 614         #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
 615
 616         if( exists( $args{timeout} ) ) {
 617                 $args{timeout} = int($args{timeout});
 618         } else {
 619                 $args{timeout} = 10;
 620         }
 621
 622         #$args{timeout} = 0 if ($self->complete);
 623
 624         $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
 625
 626         $args{count} ||= 1;
 627
 628         my $avail = @{ $self->{recv_queue} };
 629         my $time_remaining = $args{timeout};
 630
 631         while ( $avail < $args{count} and $time_remaining > 0 ) {
 632                 last if $self->complete;
 633                 my $starttime = time;
 634                 $self->queue_wait($time_remaining);
 635                 my $endtime = time;
 636                 $time_remaining -= ($endtime - $starttime);
 637                 $avail = @{ $self->{recv_queue} };
 638         }
 639
 640         #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
 641
 642         my @list;
 643         while ( my $msg = shift @{ $self->{recv_queue} } ) {
 644                 push @list, $msg;
 645                 last if (scalar(@list) >= $args{count});
 646         }
 647
 648 #       $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
 649         $logger->debug( "Number of matched responses: " . @list, DEBUG );
 650
 651         $self->queue_wait(0); # check for statuses
 652
 653         return $list[0] unless (wantarray);
 654         return @list;
 655 }
 656
 657 sub push_resend {
 658         my $self = shift;
 659         push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
 660 }
 661
 662 sub flush_resend {
 663         my $self = shift;
 664         $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
 665         while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
 666                 $req->resend;
 667         }
 668 }
 669
 670
 671 sub queue_wait {
 672         my $self = shift;
 673         if( ! $self->{peer_handle} ) { return 0; }
 674         my $timeout = shift || 0;
 675         $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
 676         $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
 677         my $o = $self->{peer_handle}->process($timeout);
 678         $logger->debug( "Timestamp after  process($timeout) : " . $logger->format_time(), INTERNAL );
 679         $self->flush_resend;
 680         return $o;
 681 }
 682
 683 sub _print_queue {
 684         my( $self ) = @_;
 685         my $string = "";
 686         foreach my $msg ( @{$self->{recv_queue}} ) {
 687                 $string = $string . $msg->toString(1) . "\n";
 688         }
 689         return $string;
 690 }
 691
 692 sub status {
 693         my $self = shift;
 694         $self->send( 'STATUS', @_ );
 695 }
 696
 697 #-------------------------------------------------------------------------------
 698
 699 package OpenSRF::AppRequest;
 700 use base qw/OpenSRF::AppSession/;
 701 use OpenSRF::Utils::Logger qw/:level/;
 702 use OpenSRF::DomainObject::oilsResponse qw/:status/;
 703
 704 sub new {
 705         my $class = shift;
 706         $class = ref($class) || $class;
 707
 708         my $session = shift;
 709         my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
 710         my $payload = shift;
 711
 712         my $self = {    session     => $session,
 713                         threadTrace => $threadTrace,
 714                         payload     => $payload,
 715                         complete    => 0,
 716                         recv_queue  => [],
 717         };
 718
 719         bless $self => $class;
 720
 721         push @{ $self->session->{request_queue} }, $self;
 722
 723         return $self;
 724 }
 725
 726 sub queue_size {
 727         my $size = @{$_[0]->{recv_queue}};
 728         return $size;
 729 }
 730
 731 sub send {
 732         shift()->session->send(@_);
 733 }
 734
 735 sub finish {
 736         my $self = shift;
 737         $self->session->remove_app_request($self);
 738         delete($$self{$_}) for (keys %$self);
 739 }
 740
 741 sub session {
 742         return shift()->{session};
 743 }
 744
 745 sub complete {
 746         my $self = shift;
 747         my $complete = shift;
 748         return $self->{complete} if ($self->{complete});
 749         if (defined $complete) {
 750                 $self->{complete} = $complete;
 751         } else {
 752                 $self->session->queue_wait(0);
 753         }
 754         return $self->{complete};
 755 }
 756
 757 sub wait_complete {
 758         my $self = shift;
 759         my $timeout = shift || 1;
 760         my $time_remaining = $timeout;
 761
 762         while ( ! $self->complete  and $time_remaining > 0 ) {
 763                 my $starttime = time;
 764                 $self->queue_wait($time_remaining);
 765                 my $endtime = time;
 766                 $time_remaining -= ($endtime - $starttime);
 767         }
 768
 769         return $self->complete;
 770 }
 771
 772 sub threadTrace {
 773         return shift()->{threadTrace};
 774 }
 775
 776 sub push_queue {
 777         my $self = shift;
 778         my $resp = shift;
 779         if( !$resp ) { return 0; }
 780         push @{ $self->{recv_queue} }, $resp;
 781         OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
 782 }
 783
 784 sub queue_wait {
 785         my $self = shift;
 786         OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
 787         return $self->session->queue_wait(@_)
 788 }
 789
 790 sub payload { return shift()->{payload}; }
 791
 792 sub resend {
 793         my $self = shift;
 794         OpenSRF::Utils::Logger->debug(
 795                 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
 796         if($self->payload) {
 797                 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
 798         }
 799         return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
 800 }
 801
 802 sub status {
 803         my $self = shift;
 804         my $msg = shift;
 805         $self->session->send( 'STATUS',$msg, $self->threadTrace );
 806 }
 807
 808 sub respond {
 809         my $self = shift;
 810         my $msg = shift;
 811
 812         my $response;
 813         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 814                 $response = $msg;
 815         } else {
 816                 $response = new OpenSRF::DomainObject::oilsResult;
 817                 $response->content($msg);
 818         }
 819
 820         $self->session->send('RESULT', $response, $self->threadTrace);
 821 }
 822
 823 sub respond_complete {
 824         my $self = shift;
 825         my $msg = shift;
 826
 827         my $response;
 828         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 829                 $response = $msg;
 830         } else {
 831                 $response = new OpenSRF::DomainObject::oilsResult;
 832                 $response->content($msg);
 833         }
 834
 835         my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
 836                 statusCode => STATUS_COMPLETE(),
 837                 status => 'Request Complete' );
 838
 839         $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
 840
 841 }
 842
 843
 844 package OpenSRF::AppSubrequest;
 845
 846 sub respond {
 847         my $self = shift;
 848         my $resp = shift;
 849         push @{$$self{resp}}, $resp;
 850 }
 851
 852 sub new {
 853         return bless({resp => []}, 'OpenSRF::AppSubrequest');
 854 }
 855
 856 sub responses { @{$_[0]->{resp}} }
 857
 858 sub status {}
 859
 860
 861 1;
 862