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         warn "Returning Targets @$targets\n";
 183         return @$targets;
 184 }
 185
 186 # When we're a client and we want to connect to a remote service
 187 # create( $app, username => $user, secret => $passwd );
 188 #    OR
 189 # create( $app, sysname => $user, secret => $shared_secret );
 190 sub create {
 191         my $class = shift;
 192         $class = ref($class) || $class;
 193
 194         my $app = shift;
 195
 196         if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
 197                         $logger->debug( "AppSession returning existing client session for $app", DEBUG );
 198                         return $thingy;
 199         } else {
 200                 $logger->debug( "AppSession creating new client session for $app", DEBUG );
 201         }
 202
 203
 204         my $sess_id = time . rand( $$ );
 205         while ( $class->find($sess_id) ) {
 206                 $sess_id = time . rand( $$ );
 207         }
 208
 209         my ($r_id) = get_app_targets($app);
 210
 211         my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
 212         if( ! $peer_handle ) {
 213                 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
 214         }
 215
 216         my $self = bless { app_name    => $app,
 217                                 #client_auth => $auth,
 218                            #recv_queue  => [],
 219                            request_queue  => [],
 220                            endpoint    => CLIENT,
 221                            state       => DISCONNECTED,#since we're init'ing
 222                            session_id  => $sess_id,
 223                            remote_id   => $r_id,
 224                            api_level   => 1,
 225                            orig_remote_id   => $r_id,
 226                                 peer_handle => $peer_handle,
 227                                 session_threadTrace => 0,
 228                          } => $class;
 229
 230         $self->client_cache();
 231         $_CACHE{$sess_id} = $self;
 232         return $self->find_client( $app );
 233 }
 234
 235 sub api_level {
 236         return shift()->{api_level};
 237 }
 238
 239 sub app {
 240         return shift()->{app_name};
 241 }
 242
 243 sub reset {
 244         my $self = shift;
 245         $self->remote_id($$self{orig_remote_id});
 246 }
 247
 248 # 'connect' can be used as a constructor if called as a class method,
 249 # or used to connect a session that has disconnectd if called against
 250 # an existing session that seems to be disconnected, or was just built
 251 # using 'create' above.
 252
 253 # connect( $app, username => $user, secret => $passwd );
 254 #    OR
 255 # connect( $app, sysname => $user, secret => $shared_secret );
 256
 257 # --- Returns undef if the connect attempt times out.
 258 # --- Returns the OpenSRF::EX object if one is returned by the server
 259 # --- Returns self if connected
 260 sub connect {
 261         my $self = shift;
 262         my $class = ref($self) || $self;
 263
 264         if ( ref( $self ) and  $self->state && $self->state == CONNECTED  ) {
 265                 $logger->transport("ABC AppSession already connected", DEBUG );
 266         } else {
 267                 $logger->transport("ABC AppSession not connected, connecting..", DEBUG );
 268         }
 269         return $self if ( ref( $self ) and  $self->state && $self->state == CONNECTED  );
 270
 271         my $app = shift;
 272         my $api_level = shift;
 273         $api_level = 1 unless (defined $api_level);
 274
 275         $self = $class->create($app, @_) if (!ref($self));
 276         return undef unless ($self);
 277
 278         $self->{api_level} = $api_level;
 279
 280         $self->reset;
 281         $self->state(CONNECTING);
 282         $self->send('CONNECT', "");
 283
 284         # if we want to connect to settings, we may not have
 285         # any data for the settings client to work with...
 286         # just using a default for now XXX
 287
 288         my $time_remaining = 5;
 289
 290 =head blah
 291         my $client = OpenSRF::Utils::SettingsClient->new();
 292         my $trans = $client->config_value("client_connection","transport_host");
 293
 294         if(!ref($trans)) {
 295                 $time_remaining = $trans->{connect_timeout};
 296         } else {
 297                 # XXX for now, just use the first
 298                 $time_remaining = $trans->[0]->{connect_timeout};
 299         }
 300 =cut
 301
 302         while ( $self->state != CONNECTED  and $time_remaining > 0 ) {
 303                 my $starttime = time;
 304                 $self->queue_wait($time_remaining);
 305                 my $endtime = time;
 306                 $time_remaining -= ($endtime - $starttime);
 307         }
 308
 309         return undef unless($self->state == CONNECTED);
 310
 311         return $self;
 312 }
 313
 314 sub finish {
 315         my $self = shift;
 316         if( ! $self->session_id ) {
 317                 return 0;
 318         }
 319         #$self->disconnect if ($self->endpoint == CLIENT);
 320         for my $ses ( @_CLIENT_CACHE ) {
 321                 if ($ses->[2]->session_id eq $self->session_id) {
 322                         $ses->[1] = 1;
 323                 }
 324         }
 325 }
 326
 327 sub kill_me {
 328         my $self = shift;
 329         if( ! $self->session_id ) { return 0; }
 330         $self->disconnect;
 331         $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
 332         my @a;
 333         for my $ses ( @_CLIENT_CACHE ) {
 334                 push @a, $ses
 335                         if ($ses->[2]->session_id ne $self->session_id);
 336         }
 337         @_CLIENT_CACHE = @a;
 338         delete $_CACHE{$self->session_id};
 339         delete($$self{$_}) for (keys %$self);
 340 }
 341
 342 sub disconnect {
 343         my $self = shift;
 344         unless( $self->state == DISCONNECTED ) {
 345                 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
 346                 $self->state( DISCONNECTED );
 347         }
 348         $self->reset;
 349 }
 350
 351 sub request {
 352         my $self = shift;
 353         my $meth = shift;
 354
 355         my $method;
 356         if (!ref $meth) {
 357                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
 358         } else {
 359                 $method = $meth;
 360         }
 361
 362         $method->params( @_ );
 363
 364         $self->send('REQUEST',$method);
 365 }
 366
 367
 368 sub send {
 369         my $self = shift;
 370         my @payload_list = @_; # this is a Domain Object
 371
 372
 373         $logger->debug( "In send", INTERNAL );
 374
 375         my $tT;
 376
 377         if( @payload_list % 2 ) { $tT = pop @payload_list; }
 378
 379         if( ! @payload_list ) {
 380                 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
 381                 return undef;
 382         }
 383
 384         my $doc = OpenSRF::DOM->createDocument();
 385
 386         $logger->debug( "In send2", INTERNAL );
 387
 388         my $disconnect = 0;
 389         my $connecting = 0;
 390
 391         while( @payload_list ) {
 392
 393                 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
 394
 395                 if ($msg_type eq 'DISCONNECT' ) {
 396                         $disconnect++;
 397                         if( $self->state == DISCONNECTED) {
 398                                 next;
 399                         }
 400                 }
 401
 402                 if( $msg_type eq "CONNECT" ) { $connecting++; }
 403
 404
 405                 if( $payload ) {
 406                         $logger->debug( "Payload is ".$payload->toString, INTERNAL );
 407                 }
 408
 409
 410                 my $msg = OpenSRF::DomainObject::oilsMessage->new();
 411                 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
 412
 413                 $msg->type($msg_type);
 414                 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
 415
 416                 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
 417
 418                 no warnings;
 419                 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
 420                 use warnings;
 421
 422                 if ($msg->type eq 'REQUEST') {
 423                         if ( !defined($tT) || $self->last_threadTrace != $tT ) {
 424                                 $msg->update_threadTrace;
 425                                 $self->session_threadTrace( $msg->threadTrace );
 426                                 $tT = $self->session_threadTrace;
 427                                 OpenSRF::AppRequest->new($self, $payload);
 428                         }
 429                 }
 430
 431                 $msg->api_level($self->api_level);
 432                 $msg->payload($payload) if $payload;
 433
 434                 $doc->documentElement->appendChild( $msg );
 435
 436
 437                 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
 438                         " with threadTrace [".$msg->threadTrace."]", INFO );
 439
 440         }
 441
 442         if ($self->endpoint == CLIENT and ! $disconnect) {
 443                 $self->queue_wait(0);
 444                 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
 445                         my $v = $self->connect();
 446                         if( ! $v ) {
 447                                 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
 448                                 return undef;
 449                         }
 450                         if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
 451                                 return $v;
 452                         }
 453                 }
 454         }
 455
 456         $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
 457
 458
 459         $self->{peer_handle}->send(
 460                                         to     => $self->remote_id,
 461                                    thread => $self->session_id,
 462                                    body   => $doc->toString );
 463
 464         return $self->app_request( $tT );
 465 }
 466
 467 sub app_request {
 468         my $self = shift;
 469         my $tT = shift;
 470
 471         return undef unless (defined $tT);
 472         my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
 473
 474         return $req;
 475 }
 476
 477 sub remove_app_request {
 478         my $self = shift;
 479         my $req = shift;
 480
 481         my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
 482
 483         $self->{request_queue} = \@list;
 484 }
 485
 486 sub endpoint {
 487         return $_[0]->{endpoint};
 488 }
 489
 490
 491 sub session_id {
 492         my $self = shift;
 493         return $self->{session_id};
 494 }
 495
 496 sub push_queue {
 497         my $self = shift;
 498         my $resp = shift;
 499         my $req = $self->app_request($resp->[1]);
 500         return $req->push_queue( $resp->[0] ) if ($req);
 501         push @{ $self->{recv_queue} }, $resp->[0];
 502 }
 503
 504 sub last_threadTrace {
 505         my $self = shift;
 506         my $new_last_threadTrace = shift;
 507
 508         my $old_last_threadTrace = $self->{last_threadTrace};
 509         if (defined $new_last_threadTrace) {
 510                 $self->{last_threadTrace} = $new_last_threadTrace;
 511                 return $new_last_threadTrace unless ($old_last_threadTrace);
 512         }
 513
 514         return $old_last_threadTrace;
 515 }
 516
 517 sub session_threadTrace {
 518         my $self = shift;
 519         my $new_last_threadTrace = shift;
 520
 521         my $old_last_threadTrace = $self->{session_threadTrace};
 522         if (defined $new_last_threadTrace) {
 523                 $self->{session_threadTrace} = $new_last_threadTrace;
 524                 return $new_last_threadTrace unless ($old_last_threadTrace);
 525         }
 526
 527         return $old_last_threadTrace;
 528 }
 529
 530 sub last_message_type {
 531         my $self = shift;
 532         my $new_last_message_type = shift;
 533
 534         my $old_last_message_type = $self->{last_message_type};
 535         if (defined $new_last_message_type) {
 536                 $self->{last_message_type} = $new_last_message_type;
 537                 return $new_last_message_type unless ($old_last_message_type);
 538         }
 539
 540         return $old_last_message_type;
 541 }
 542
 543 sub last_message_api_level {
 544         my $self = shift;
 545         my $new_last_message_api_level = shift;
 546
 547         my $old_last_message_api_level = $self->{last_message_api_level};
 548         if (defined $new_last_message_api_level) {
 549                 $self->{last_message_api_level} = $new_last_message_api_level;
 550                 return $new_last_message_api_level unless ($old_last_message_api_level);
 551         }
 552
 553         return $old_last_message_api_level;
 554 }
 555
 556 sub remote_id {
 557         my $self = shift;
 558         my $new_remote_id = shift;
 559
 560         my $old_remote_id = $self->{remote_id};
 561         if (defined $new_remote_id) {
 562                 $self->{remote_id} = $new_remote_id;
 563                 return $new_remote_id unless ($old_remote_id);
 564         }
 565
 566         return $old_remote_id;
 567 }
 568
 569 sub client_auth {
 570         return undef;
 571         my $self = shift;
 572         my $new_ua = shift;
 573
 574         my $old_ua = $self->{client_auth};
 575         if (defined $new_ua) {
 576                 $self->{client_auth} = $new_ua;
 577                 return $new_ua unless ($old_ua);
 578         }
 579
 580         return $old_ua->cloneNode(1);
 581 }
 582
 583 sub state {
 584         my $self = shift;
 585         my $new_state = shift;
 586
 587         my $old_state = $self->{state};
 588         if (defined $new_state) {
 589                 $self->{state} = $new_state;
 590                 return $new_state unless ($old_state);
 591         }
 592
 593         return $old_state;
 594 }
 595
 596 sub DESTROY {
 597         my $self = shift;
 598         delete $$self{$_} for keys %$self;
 599         return undef;
 600 }
 601
 602 sub recv {
 603         my $self = shift;
 604         my @proto_args = @_;
 605         my %args;
 606
 607         if ( @proto_args ) {
 608                 if ( !(@proto_args % 2) ) {
 609                         %args = @proto_args;
 610                 } elsif (@proto_args == 1) {
 611                         %args = ( timeout => @proto_args );
 612                 }
 613         }
 614
 615         #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
 616
 617         if( exists( $args{timeout} ) ) {
 618                 $args{timeout} = int($args{timeout});
 619         } else {
 620                 $args{timeout} = 10;
 621         }
 622
 623         #$args{timeout} = 0 if ($self->complete);
 624
 625         $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
 626
 627         $args{count} ||= 1;
 628
 629         my $avail = @{ $self->{recv_queue} };
 630         my $time_remaining = $args{timeout};
 631
 632         while ( $avail < $args{count} and $time_remaining > 0 ) {
 633                 last if $self->complete;
 634                 my $starttime = time;
 635                 $self->queue_wait($time_remaining);
 636                 my $endtime = time;
 637                 $time_remaining -= ($endtime - $starttime);
 638                 $avail = @{ $self->{recv_queue} };
 639         }
 640
 641         #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
 642
 643         my @list;
 644         while ( my $msg = shift @{ $self->{recv_queue} } ) {
 645                 push @list, $msg;
 646                 last if (scalar(@list) >= $args{count});
 647         }
 648
 649 #       $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
 650         $logger->debug( "Number of matched responses: " . @list, DEBUG );
 651
 652         $self->queue_wait(0); # check for statuses
 653
 654         return $list[0] unless (wantarray);
 655         return @list;
 656 }
 657
 658 sub push_resend {
 659         my $self = shift;
 660         push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
 661 }
 662
 663 sub flush_resend {
 664         my $self = shift;
 665         $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
 666         while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
 667                 $req->resend;
 668         }
 669 }
 670
 671
 672 sub queue_wait {
 673         my $self = shift;
 674         if( ! $self->{peer_handle} ) { return 0; }
 675         my $timeout = shift || 0;
 676         $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
 677         $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
 678         my $o = $self->{peer_handle}->process($timeout);
 679         $logger->debug( "Timestamp after  process($timeout) : " . $logger->format_time(), INTERNAL );
 680         $self->flush_resend;
 681         return $o;
 682 }
 683
 684 sub _print_queue {
 685         my( $self ) = @_;
 686         my $string = "";
 687         foreach my $msg ( @{$self->{recv_queue}} ) {
 688                 $string = $string . $msg->toString(1) . "\n";
 689         }
 690         return $string;
 691 }
 692
 693 sub status {
 694         my $self = shift;
 695         $self->send( 'STATUS', @_ );
 696 }
 697
 698 #-------------------------------------------------------------------------------
 699
 700 package OpenSRF::AppRequest;
 701 use base qw/OpenSRF::AppSession/;
 702 use OpenSRF::Utils::Logger qw/:level/;
 703 use OpenSRF::DomainObject::oilsResponse qw/:status/;
 704
 705 sub new {
 706         my $class = shift;
 707         $class = ref($class) || $class;
 708
 709         my $session = shift;
 710         my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
 711         my $payload = shift;
 712
 713         my $self = {    session     => $session,
 714                         threadTrace => $threadTrace,
 715                         payload     => $payload,
 716                         complete    => 0,
 717                         recv_queue  => [],
 718         };
 719
 720         bless $self => $class;
 721
 722         push @{ $self->session->{request_queue} }, $self;
 723
 724         return $self;
 725 }
 726
 727 sub queue_size {
 728         my $size = @{$_[0]->{recv_queue}};
 729         return $size;
 730 }
 731
 732 sub send {
 733         shift()->session->send(@_);
 734 }
 735
 736 sub finish {
 737         my $self = shift;
 738         $self->session->remove_app_request($self);
 739         delete($$self{$_}) for (keys %$self);
 740 }
 741
 742 sub session {
 743         return shift()->{session};
 744 }
 745
 746 sub complete {
 747         my $self = shift;
 748         my $complete = shift;
 749         return $self->{complete} if ($self->{complete});
 750         if (defined $complete) {
 751                 $self->{complete} = $complete;
 752         } else {
 753                 $self->session->queue_wait(0);
 754         }
 755         return $self->{complete};
 756 }
 757
 758 sub wait_complete {
 759         my $self = shift;
 760         my $timeout = shift || 1;
 761         my $time_remaining = $timeout;
 762
 763         while ( ! $self->complete  and $time_remaining > 0 ) {
 764                 my $starttime = time;
 765                 $self->queue_wait($time_remaining);
 766                 my $endtime = time;
 767                 $time_remaining -= ($endtime - $starttime);
 768         }
 769
 770         return $self->complete;
 771 }
 772
 773 sub threadTrace {
 774         return shift()->{threadTrace};
 775 }
 776
 777 sub push_queue {
 778         my $self = shift;
 779         my $resp = shift;
 780         if( !$resp ) { return 0; }
 781         push @{ $self->{recv_queue} }, $resp;
 782         OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
 783 }
 784
 785 sub queue_wait {
 786         my $self = shift;
 787         OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
 788         return $self->session->queue_wait(@_)
 789 }
 790
 791 sub payload { return shift()->{payload}; }
 792
 793 sub resend {
 794         my $self = shift;
 795         OpenSRF::Utils::Logger->debug(
 796                 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
 797         if($self->payload) {
 798                 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
 799         }
 800         return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
 801 }
 802
 803 sub status {
 804         my $self = shift;
 805         my $msg = shift;
 806         $self->session->send( 'STATUS',$msg, $self->threadTrace );
 807 }
 808
 809 sub respond {
 810         my $self = shift;
 811         my $msg = shift;
 812
 813         my $response;
 814         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 815                 $response = $msg;
 816         } else {
 817                 $response = new OpenSRF::DomainObject::oilsResult;
 818                 $response->content($msg);
 819         }
 820
 821         $self->session->send('RESULT', $response, $self->threadTrace);
 822 }
 823
 824 sub respond_complete {
 825         my $self = shift;
 826         my $msg = shift;
 827
 828         my $response;
 829         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 830                 $response = $msg;
 831         } else {
 832                 $response = new OpenSRF::DomainObject::oilsResult;
 833                 $response->content($msg);
 834         }
 835
 836         my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
 837                 statusCode => STATUS_COMPLETE(),
 838                 status => 'Request Complete' );
 839
 840         $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
 841
 842 }
 843
 844
 845 package OpenSRF::AppSubrequest;
 846
 847 sub respond {
 848         my $self = shift;
 849         my $resp = shift;
 850         push @{$$self{resp}}, $resp;
 851 }
 852
 853 sub new {
 854         return bless({resp => []}, 'OpenSRF::AppSubrequest');
 855 }
 856
 857 sub responses { @{$_[0]->{resp}} }
 858
 859 sub status {}
 860
 861
 862 1;
 863