OpenSRF/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                            death_callbacks  => [],
 129                            endpoint    => SERVER,
 130                            state       => CONNECTING,
 131                            session_id  => $sess_id,
 132                            remote_id    => $remote_id,
 133                                 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
 134                                 max_requests => $max_requests,
 135                                 session_threadTrace => 0,
 136                                 service => $service,
 137                          } => $class;
 138
 139         return $_CACHE{$sess_id} = $self;
 140 }
 141
 142 sub service { return shift()->{service}; }
 143
 144 sub continue_request {
 145         my $self = shift;
 146         $self->{'requests'}++;
 147         return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
 148 }
 149
 150 sub last_sent_payload {
 151         my( $self, $payload ) = @_;
 152         if( $payload ) {
 153                 return $self->{'last_sent_payload'} = $payload;
 154         }
 155         return $self->{'last_sent_payload'};
 156 }
 157
 158 sub last_sent_type {
 159         my( $self, $type ) = @_;
 160         if( $type ) {
 161                 return $self->{'last_sent_type'} = $type;
 162         }
 163         return $self->{'last_sent_type'};
 164 }
 165
 166 sub get_app_targets {
 167         my $app = shift;
 168
 169         my $targets;
 170         my $config_client = OpenSRF::Utils::SettingsClient->new();
 171
 172         if( $app eq "settings" ) { # we have to load from the bootstrap config file
 173
 174                 my $conf = OpenSRF::Utils::Config->current;
 175                 if(!$conf) { die("No transport target for $app!"); }
 176                 $targets = $conf->targets->$app || die("No transport target for $app!");
 177
 178         } else {
 179                 $targets =  $config_client->config_value("apps",$app,"transport_targets", "router_target");
 180                 if( !ref($targets) ) { $targets = [ $targets ]; }
 181         }
 182
 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 register_death_callback {
 328         my $self = shift;
 329         my $cb = shift;
 330         push @{ $self->{death_callbacks} }, $cb;
 331 }
 332
 333 sub kill_me {
 334         my $self = shift;
 335         if( ! $self->session_id ) { return 0; }
 336
 337         # run each 'kill_me' callback;
 338         for my $sub (@{$self->{death_callbacks}}) {
 339                 $sub->($self);
 340         }
 341
 342         $self->disconnect;
 343         $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
 344         my @a;
 345         for my $ses ( @_CLIENT_CACHE ) {
 346                 push @a, $ses
 347                         if ($ses->[2]->session_id ne $self->session_id);
 348         }
 349         @_CLIENT_CACHE = @a;
 350         delete $_CACHE{$self->session_id};
 351         delete($$self{$_}) for (keys %$self);
 352 }
 353
 354 sub disconnect {
 355         my $self = shift;
 356         unless( $self->state == DISCONNECTED ) {
 357                 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
 358                 $self->state( DISCONNECTED );
 359         }
 360         $self->reset;
 361 }
 362
 363 sub request {
 364         my $self = shift;
 365         my $meth = shift;
 366
 367         my $method;
 368         if (!ref $meth) {
 369                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
 370         } else {
 371                 $method = $meth;
 372         }
 373
 374         $method->params( @_ );
 375
 376         $self->send('REQUEST',$method);
 377 }
 378
 379
 380 sub send {
 381         my $self = shift;
 382         my @payload_list = @_; # this is a Domain Object
 383
 384
 385         $logger->debug( "In send", INTERNAL );
 386
 387         my $tT;
 388
 389         if( @payload_list % 2 ) { $tT = pop @payload_list; }
 390
 391         if( ! @payload_list ) {
 392                 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
 393                 return undef;
 394         }
 395
 396         my $doc = OpenSRF::DOM->createDocument();
 397
 398         $logger->debug( "In send2", INTERNAL );
 399
 400         my $disconnect = 0;
 401         my $connecting = 0;
 402
 403         while( @payload_list ) {
 404
 405                 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
 406
 407                 if ($msg_type eq 'DISCONNECT' ) {
 408                         $disconnect++;
 409                         if( $self->state == DISCONNECTED) {
 410                                 next;
 411                         }
 412                 }
 413
 414                 if( $msg_type eq "CONNECT" ) { $connecting++; }
 415
 416
 417                 if( $payload ) {
 418                         $logger->debug( "Payload is ".$payload->toString, INTERNAL );
 419                 }
 420
 421
 422                 my $msg = OpenSRF::DomainObject::oilsMessage->new();
 423                 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
 424
 425                 $msg->type($msg_type);
 426                 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
 427
 428                 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
 429
 430                 no warnings;
 431                 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
 432                 use warnings;
 433
 434                 if ($msg->type eq 'REQUEST') {
 435                         if ( !defined($tT) || $self->last_threadTrace != $tT ) {
 436                                 $msg->update_threadTrace;
 437                                 $self->session_threadTrace( $msg->threadTrace );
 438                                 $tT = $self->session_threadTrace;
 439                                 OpenSRF::AppRequest->new($self, $payload);
 440                         }
 441                 }
 442
 443                 $msg->api_level($self->api_level);
 444                 $msg->payload($payload) if $payload;
 445
 446                 $doc->documentElement->appendChild( $msg );
 447
 448
 449                 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
 450                         " with threadTrace [".$msg->threadTrace."]", INFO );
 451
 452         }
 453
 454         if ($self->endpoint == CLIENT and ! $disconnect) {
 455                 $self->queue_wait(0);
 456                 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
 457                         my $v = $self->connect();
 458                         if( ! $v ) {
 459                                 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
 460                                 return undef;
 461                         }
 462                         if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
 463                                 return $v;
 464                         }
 465                 }
 466         }
 467
 468         $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
 469
 470
 471         $self->{peer_handle}->send(
 472                                         to     => $self->remote_id,
 473                                    thread => $self->session_id,
 474                                    body   => $doc->toString );
 475
 476         return $self->app_request( $tT );
 477 }
 478
 479 sub app_request {
 480         my $self = shift;
 481         my $tT = shift;
 482
 483         return undef unless (defined $tT);
 484         my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
 485
 486         return $req;
 487 }
 488
 489 sub remove_app_request {
 490         my $self = shift;
 491         my $req = shift;
 492
 493         my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
 494
 495         $self->{request_queue} = \@list;
 496 }
 497
 498 sub endpoint {
 499         return $_[0]->{endpoint};
 500 }
 501
 502
 503 sub session_id {
 504         my $self = shift;
 505         return $self->{session_id};
 506 }
 507
 508 sub push_queue {
 509         my $self = shift;
 510         my $resp = shift;
 511         my $req = $self->app_request($resp->[1]);
 512         return $req->push_queue( $resp->[0] ) if ($req);
 513         push @{ $self->{recv_queue} }, $resp->[0];
 514 }
 515
 516 sub last_threadTrace {
 517         my $self = shift;
 518         my $new_last_threadTrace = shift;
 519
 520         my $old_last_threadTrace = $self->{last_threadTrace};
 521         if (defined $new_last_threadTrace) {
 522                 $self->{last_threadTrace} = $new_last_threadTrace;
 523                 return $new_last_threadTrace unless ($old_last_threadTrace);
 524         }
 525
 526         return $old_last_threadTrace;
 527 }
 528
 529 sub session_threadTrace {
 530         my $self = shift;
 531         my $new_last_threadTrace = shift;
 532
 533         my $old_last_threadTrace = $self->{session_threadTrace};
 534         if (defined $new_last_threadTrace) {
 535                 $self->{session_threadTrace} = $new_last_threadTrace;
 536                 return $new_last_threadTrace unless ($old_last_threadTrace);
 537         }
 538
 539         return $old_last_threadTrace;
 540 }
 541
 542 sub last_message_type {
 543         my $self = shift;
 544         my $new_last_message_type = shift;
 545
 546         my $old_last_message_type = $self->{last_message_type};
 547         if (defined $new_last_message_type) {
 548                 $self->{last_message_type} = $new_last_message_type;
 549                 return $new_last_message_type unless ($old_last_message_type);
 550         }
 551
 552         return $old_last_message_type;
 553 }
 554
 555 sub last_message_api_level {
 556         my $self = shift;
 557         my $new_last_message_api_level = shift;
 558
 559         my $old_last_message_api_level = $self->{last_message_api_level};
 560         if (defined $new_last_message_api_level) {
 561                 $self->{last_message_api_level} = $new_last_message_api_level;
 562                 return $new_last_message_api_level unless ($old_last_message_api_level);
 563         }
 564
 565         return $old_last_message_api_level;
 566 }
 567
 568 sub remote_id {
 569         my $self = shift;
 570         my $new_remote_id = shift;
 571
 572         my $old_remote_id = $self->{remote_id};
 573         if (defined $new_remote_id) {
 574                 $self->{remote_id} = $new_remote_id;
 575                 return $new_remote_id unless ($old_remote_id);
 576         }
 577
 578         return $old_remote_id;
 579 }
 580
 581 sub client_auth {
 582         return undef;
 583         my $self = shift;
 584         my $new_ua = shift;
 585
 586         my $old_ua = $self->{client_auth};
 587         if (defined $new_ua) {
 588                 $self->{client_auth} = $new_ua;
 589                 return $new_ua unless ($old_ua);
 590         }
 591
 592         return $old_ua->cloneNode(1);
 593 }
 594
 595 sub state {
 596         my $self = shift;
 597         my $new_state = shift;
 598
 599         my $old_state = $self->{state};
 600         if (defined $new_state) {
 601                 $self->{state} = $new_state;
 602                 return $new_state unless ($old_state);
 603         }
 604
 605         return $old_state;
 606 }
 607
 608 sub DESTROY {
 609         my $self = shift;
 610         delete $$self{$_} for keys %$self;
 611         return undef;
 612 }
 613
 614 sub recv {
 615         my $self = shift;
 616         my @proto_args = @_;
 617         my %args;
 618
 619         if ( @proto_args ) {
 620                 if ( !(@proto_args % 2) ) {
 621                         %args = @proto_args;
 622                 } elsif (@proto_args == 1) {
 623                         %args = ( timeout => @proto_args );
 624                 }
 625         }
 626
 627         #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
 628
 629         if( exists( $args{timeout} ) ) {
 630                 $args{timeout} = int($args{timeout});
 631         } else {
 632                 $args{timeout} = 10;
 633         }
 634
 635         #$args{timeout} = 0 if ($self->complete);
 636
 637         $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
 638
 639         $args{count} ||= 1;
 640
 641         my $avail = @{ $self->{recv_queue} };
 642         my $time_remaining = $args{timeout};
 643
 644         while ( $avail < $args{count} and $time_remaining > 0 ) {
 645                 last if $self->complete;
 646                 my $starttime = time;
 647                 $self->queue_wait($time_remaining);
 648                 my $endtime = time;
 649                 $time_remaining -= ($endtime - $starttime);
 650                 $avail = @{ $self->{recv_queue} };
 651         }
 652
 653         #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
 654
 655         my @list;
 656         while ( my $msg = shift @{ $self->{recv_queue} } ) {
 657                 push @list, $msg;
 658                 last if (scalar(@list) >= $args{count});
 659         }
 660
 661 #       $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
 662         $logger->debug( "Number of matched responses: " . @list, DEBUG );
 663
 664         $self->queue_wait(0); # check for statuses
 665
 666         return $list[0] unless (wantarray);
 667         return @list;
 668 }
 669
 670 sub push_resend {
 671         my $self = shift;
 672         push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
 673 }
 674
 675 sub flush_resend {
 676         my $self = shift;
 677         $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
 678         while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
 679                 $req->resend;
 680         }
 681 }
 682
 683
 684 sub queue_wait {
 685         my $self = shift;
 686         if( ! $self->{peer_handle} ) { return 0; }
 687         my $timeout = shift || 0;
 688         $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
 689         $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
 690         my $o = $self->{peer_handle}->process($timeout);
 691         $logger->debug( "Timestamp after  process($timeout) : " . $logger->format_time(), INTERNAL );
 692         $self->flush_resend;
 693         return $o;
 694 }
 695
 696 sub _print_queue {
 697         my( $self ) = @_;
 698         my $string = "";
 699         foreach my $msg ( @{$self->{recv_queue}} ) {
 700                 $string = $string . $msg->toString(1) . "\n";
 701         }
 702         return $string;
 703 }
 704
 705 sub status {
 706         my $self = shift;
 707         $self->send( 'STATUS', @_ );
 708 }
 709
 710 #-------------------------------------------------------------------------------
 711
 712 package OpenSRF::AppRequest;
 713 use base qw/OpenSRF::AppSession/;
 714 use OpenSRF::Utils::Logger qw/:level/;
 715 use OpenSRF::DomainObject::oilsResponse qw/:status/;
 716
 717 sub new {
 718         my $class = shift;
 719         $class = ref($class) || $class;
 720
 721         my $session = shift;
 722         my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
 723         my $payload = shift;
 724
 725         my $self = {    session     => $session,
 726                         threadTrace => $threadTrace,
 727                         payload     => $payload,
 728                         complete    => 0,
 729                         recv_queue  => [],
 730         };
 731
 732         bless $self => $class;
 733
 734         push @{ $self->session->{request_queue} }, $self;
 735
 736         return $self;
 737 }
 738
 739 sub queue_size {
 740         my $size = @{$_[0]->{recv_queue}};
 741         return $size;
 742 }
 743
 744 sub send {
 745         shift()->session->send(@_);
 746 }
 747
 748 sub finish {
 749         my $self = shift;
 750         $self->session->remove_app_request($self);
 751         delete($$self{$_}) for (keys %$self);
 752 }
 753
 754 sub session {
 755         return shift()->{session};
 756 }
 757
 758 sub complete {
 759         my $self = shift;
 760         my $complete = shift;
 761         return $self->{complete} if ($self->{complete});
 762         if (defined $complete) {
 763                 $self->{complete} = $complete;
 764         } else {
 765                 $self->session->queue_wait(0);
 766         }
 767         return $self->{complete};
 768 }
 769
 770 sub wait_complete {
 771         my $self = shift;
 772         my $timeout = shift || 1;
 773         my $time_remaining = $timeout;
 774
 775         while ( ! $self->complete  and $time_remaining > 0 ) {
 776                 my $starttime = time;
 777                 $self->queue_wait($time_remaining);
 778                 my $endtime = time;
 779                 $time_remaining -= ($endtime - $starttime);
 780         }
 781
 782         return $self->complete;
 783 }
 784
 785 sub threadTrace {
 786         return shift()->{threadTrace};
 787 }
 788
 789 sub push_queue {
 790         my $self = shift;
 791         my $resp = shift;
 792         if( !$resp ) { return 0; }
 793         push @{ $self->{recv_queue} }, $resp;
 794         OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
 795 }
 796
 797 sub queue_wait {
 798         my $self = shift;
 799         OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
 800         return $self->session->queue_wait(@_)
 801 }
 802
 803 sub payload { return shift()->{payload}; }
 804
 805 sub resend {
 806         my $self = shift;
 807         OpenSRF::Utils::Logger->debug(
 808                 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
 809         if($self->payload) {
 810                 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
 811         }
 812         return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
 813 }
 814
 815 sub status {
 816         my $self = shift;
 817         my $msg = shift;
 818         $self->session->send( 'STATUS',$msg, $self->threadTrace );
 819 }
 820
 821 sub respond {
 822         my $self = shift;
 823         my $msg = shift;
 824
 825         my $response;
 826         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 827                 $response = $msg;
 828         } else {
 829                 $response = new OpenSRF::DomainObject::oilsResult;
 830                 $response->content($msg);
 831         }
 832
 833         $self->session->send('RESULT', $response, $self->threadTrace);
 834 }
 835
 836 sub respond_complete {
 837         my $self = shift;
 838         my $msg = shift;
 839
 840         my $response;
 841         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 842                 $response = $msg;
 843         } else {
 844                 $response = new OpenSRF::DomainObject::oilsResult;
 845                 $response->content($msg);
 846         }
 847
 848         my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
 849                 statusCode => STATUS_COMPLETE(),
 850                 status => 'Request Complete' );
 851
 852         $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
 853
 854 }
 855
 856 sub register_death_callback {
 857         my $self = shift;
 858         my $cb = shift;
 859         $self->session->register_death_callback( $cb );
 860 }
 861
 862 package OpenSRF::AppSubrequest;
 863
 864 sub respond {
 865         my $self = shift;
 866         my $resp = shift;
 867         push @{$$self{resp}}, $resp;
 868 }
 869
 870 sub new {
 871         return bless({resp => []}, 'OpenSRF::AppSubrequest');
 872 }
 873
 874 sub responses { @{$_[0]->{resp}} }
 875
 876 sub status {}
 877
 878
 879 1;
 880