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