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