1 package OpenSRF::AppSession;
2 use OpenSRF::DomainObject::oilsMessage;
3 use OpenSRF::DomainObject::oilsMethod;
4 use OpenSRF::DomainObject::oilsResponse qw/:status/;
5 use OpenSRF::Transport::PeerHandle;
6 use OpenSRF::Utils::JSON;
7 use OpenSRF::Utils::Logger qw(:level);
8 use OpenSRF::Utils::SettingsClient;
9 use OpenSRF::Utils::Config;
13 use base qw/Exporter OpenSRF/;
14 use Time::HiRes qw( time usleep );
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/ ],
23 my $logger = "OpenSRF::Utils::Logger";
24 my $_last_locale = 'en-US';
25 our $current_ingress = 'opensrf';
27 # Get/set the locale used by all new client sessions
28 # for the current process. This is primarily useful
29 # for clients that wish to make a series of opensrf
30 # calls and don't wish to set the locale for each new
33 # The caller should reset the locale when done using
34 # reset_locale(), as the locale will otherwise persist
35 # for the current process until set/reset again.
37 # This is not for SERVER processes, since they
38 # adopt the locale of their respective callers.
40 my ($class, $locale) = @_;
41 $_last_locale = $locale if $locale;
46 return $_last_locale = 'en-US';
50 my ($class, $ingress) = @_;
51 $current_ingress = $ingress if $ingress;
52 return $current_ingress;
58 sub CONNECTING { return 3 };
59 sub INIT_CONNECTED { return 4 };
60 sub CONNECTED { return 1 };
61 sub DISCONNECTED { return 2 };
63 sub CLIENT { return 2 };
64 sub SERVER { return 1 };
67 return undef unless (defined $_[1]);
68 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
71 sub transport_connected {
73 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
76 return $self->{peer_handle}->tcp_connected();
81 return $self->state == CONNECTED;
83 # ----------------------------------------------------------------------------
84 # Clears the transport buffers
85 # call this if you are not through with the sesssion, but you want
86 # to have a clean slate. You shouldn't have to call this if
87 # you are correctly 'recv'ing all of the data from a request.
88 # however, if you don't want all of the data, this will
89 # slough off any excess
90 # * * Note: This will delete data for all sessions using this transport
91 # handle. For example, all client sessions use the same handle.
92 # ----------------------------------------------------------------------------
96 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
99 $self->{peer_handle}->buffer_reset();
103 # when any incoming data is received, this method is called.
106 $class = ref($class) || $class;
109 my $remote_id = shift;
112 warn "Missing args to server_build():\n" .
113 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
114 unless ($sess_id and $remote_id and $service);
116 return undef unless ($sess_id and $remote_id and $service);
118 if ( my $thingy = $class->find($sess_id) ) {
119 $thingy->remote_id( $remote_id );
123 if( $service eq "client" ) {
124 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
125 # " Session ID [$sess_id], remote_id [$remote_id]");
127 warn "Attempting to build a client session as ".
128 "a server Session ID [$sess_id], remote_id [$remote_id]";
130 $logger->debug("Attempting to build a client session as ".
131 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
136 my $config_client = OpenSRF::Utils::SettingsClient->new();
137 my $stateless = $config_client->config_value("apps", $service, "stateless");
139 #my $max_requests = $conf->$service->max_requests;
140 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
141 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
143 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
145 my $self = bless { recv_queue => [],
152 session_id => $sess_id,
153 remote_id => $remote_id,
154 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
155 max_requests => $max_requests,
156 session_threadTrace => 0,
158 stateless => $stateless,
161 return $_CACHE{$sess_id} = $self;
166 my ($name, $datum) = @_;
168 $self->{session_data}->{$name} = $datum if (defined $datum);
169 return $self->{session_data}->{$name};
172 sub service { return shift()->{service}; }
174 sub continue_request {
176 $self->{'requests'}++;
177 return 1 if (!$self->{'max_requests'});
178 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
181 sub last_sent_payload {
182 my( $self, $payload ) = @_;
184 return $self->{'last_sent_payload'} = $payload;
186 return $self->{'last_sent_payload'};
190 my( $self, $type ) = @_;
192 $_last_locale = $type if ($self->endpoint == SERVER);
193 return $self->{'session_locale'} = $type;
195 return $self->{'session_locale'};
199 my( $self, $type ) = @_;
201 return $self->{'last_sent_type'} = $type;
203 return $self->{'last_sent_type'};
206 sub get_app_targets {
209 my $conf = OpenSRF::Utils::Config->current;
210 my $router_name = $conf->bootstrap->router_name || 'router';
211 my $domain = $conf->bootstrap->domain;
212 $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
214 unless($router_name and $domain) {
215 throw OpenSRF::EX::Config
216 ("Missing router config information 'router_name' and 'domain'");
219 return ("$router_name\@$domain/$app");
225 $self->{stateless} = $state if (defined $state);
226 return $self->{stateless};
229 # When we're a client and we want to connect to a remote service
232 $class = ref($class) || $class;
235 my $api_level = shift;
237 my $locale = shift || $_last_locale;
239 $api_level = 1 if (!defined($api_level));
241 $logger->debug( "AppSession creating new client session for $app", DEBUG );
244 my $c = OpenSRF::Utils::SettingsClient->new();
245 # we can get an infinite loop if we're grabbing the settings and we
246 # need the settings to grab the settings...
247 if($app ne "opensrf.settings" || $c->has_config()) {
248 $stateless = $c->config_value("apps", $app, "stateless");
251 my $sess_id = time . rand( $$ );
252 while ( $class->find($sess_id) ) {
253 $sess_id = time . rand( $$ );
257 my ($r_id) = get_app_targets($app);
259 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
260 if( ! $peer_handle ) {
261 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
264 my $self = bless { app_name => $app,
267 state => DISCONNECTED,#since we're init'ing
268 session_id => $sess_id,
270 raise_error => $quiet ? 0 : 1,
271 session_locale => $locale,
272 api_level => $api_level,
273 orig_remote_id => $r_id,
274 peer_handle => $peer_handle,
275 session_threadTrace => 0,
276 stateless => $stateless,
279 $logger->debug( "Created new client session $app : $sess_id" );
281 return $_CACHE{$sess_id} = $self;
284 sub raise_remote_errors {
287 $self->{raise_error} = $err if (defined $err);
288 return $self->{raise_error};
292 return shift()->{api_level};
296 return shift()->{app_name};
301 $self->remote_id($$self{orig_remote_id});
304 # 'connect' can be used as a constructor if called as a class method,
305 # or used to connect a session that has disconnectd if called against
306 # an existing session that seems to be disconnected, or was just built
307 # using 'create' above.
309 # connect( $app, username => $user, secret => $passwd );
311 # connect( $app, sysname => $user, secret => $shared_secret );
313 # --- Returns undef if the connect attempt times out.
314 # --- Returns the OpenSRF::EX object if one is returned by the server
315 # --- Returns self if connected
318 my $class = ref($self) || $self;
321 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
322 $logger->transport("AppSession already connected", DEBUG );
324 $logger->transport("AppSession not connected, connecting..", DEBUG );
326 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
330 my $api_level = shift;
331 $api_level = 1 unless (defined $api_level);
333 $self = $class->create($app, @_) if (!ref($self));
335 return undef unless ($self);
337 $self->{api_level} = $api_level;
340 $self->state(CONNECTING);
341 $self->send('CONNECT', "");
344 # if we want to connect to settings, we may not have
345 # any data for the settings client to work with...
346 # just using a default for now XXX
348 my $time_remaining = 5;
351 # my $client = OpenSRF::Utils::SettingsClient->new();
352 # my $trans = $client->config_value("client_connection","transport_host");
355 # $time_remaining = $trans->{connect_timeout};
357 # # XXX for now, just use the first
358 # $time_remaining = $trans->[0]->{connect_timeout};
361 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
362 my $starttime = time;
363 $self->queue_wait($time_remaining);
365 $time_remaining -= ($endtime - $starttime);
368 return undef unless($self->state == CONNECTED);
377 if( ! $self->session_id ) {
382 sub unregister_callback {
386 if (exists $self->{callbacks}{$type}) {
387 delete $self->{callbacks}{$type}{$cb};
393 sub register_callback {
398 $self->{callbacks}{$type}{$cb_key} = $cb;
404 if( ! $self->session_id ) { return 0; }
406 # run each 'death' callback;
407 if (exists $self->{callbacks}{death}) {
408 for my $sub (values %{$self->{callbacks}{death}}) {
414 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
415 delete $_CACHE{$self->session_id};
416 delete($$self{$_}) for (keys %$self);
422 # run each 'disconnect' callback;
423 if (exists $self->{callbacks}{disconnect}) {
424 for my $sub (values %{$self->{callbacks}{disconnect}}) {
429 if ( !$self->stateless and $self->state != DISCONNECTED ) {
430 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
431 $self->state( DISCONNECTED );
442 # tell the logger to create a new xid - the logger will decide if it's really necessary
443 $logger->mk_osrf_xid;
447 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
452 $method->params( @_ );
454 $self->send('REQUEST',$method);
463 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
468 $method->params( @_ );
470 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
475 my @payload_list = @_; # this is a Domain Object
477 return unless ($self and $self->{peer_handle});
479 $logger->debug( "In send", INTERNAL );
483 if( @payload_list % 2 ) { $tT = pop @payload_list; }
485 if( ! @payload_list ) {
486 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
495 while( @payload_list ) {
497 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
499 if ($msg_type eq 'DISCONNECT' ) {
501 if( $self->state == DISCONNECTED && !$connecting) {
506 if( $msg_type eq "CONNECT" ) {
510 my $msg = OpenSRF::DomainObject::oilsMessage->new();
511 $msg->type($msg_type);
514 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
517 if ($msg->type eq 'REQUEST') {
518 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
519 $msg->update_threadTrace;
520 $self->session_threadTrace( $msg->threadTrace );
521 $tT = $self->session_threadTrace;
522 OpenSRF::AppRequest->new($self, $payload);
526 $msg->api_level($self->api_level);
527 $msg->payload($payload) if $payload;
529 my $locale = $self->session_locale;
530 $msg->sender_locale($locale) if ($locale);
532 $msg->sender_ingress($current_ingress);
537 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
538 " with threadTrace [".$msg->threadTrace."]");
542 if ($self->endpoint == CLIENT and ! $disconnect) {
543 $self->queue_wait(0);
546 if($self->stateless && $self->state != CONNECTED) {
548 $logger->debug("AppSession is stateless in send", INTERNAL );
551 if( !$self->stateless and $self->state != CONNECTED ) {
553 $logger->debug( "Sending connect before request 1", INTERNAL );
555 unless (($self->state == CONNECTING && $connecting )) {
556 $logger->debug( "Sending connect before request 2", INTERNAL );
557 my $v = $self->connect();
559 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
562 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
569 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
570 $logger->internal("AppSession sending doc: $json");
572 $self->{peer_handle}->send(
573 to => $self->remote_id,
574 thread => $self->session_id,
578 $self->state( DISCONNECTED );
581 my $req = $self->app_request( $tT );
582 $req->{_start} = time;
590 return undef unless (defined $tT);
591 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
596 sub remove_app_request {
600 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
602 $self->{request_queue} = \@list;
606 return $_[0]->{endpoint};
612 return $self->{session_id};
618 my $req = $self->app_request($resp->[1]);
619 return $req->push_queue( $resp->[0] ) if ($req);
620 push @{ $self->{recv_queue} }, $resp->[0];
623 sub last_threadTrace {
625 my $new_last_threadTrace = shift;
627 my $old_last_threadTrace = $self->{last_threadTrace};
628 if (defined $new_last_threadTrace) {
629 $self->{last_threadTrace} = $new_last_threadTrace;
630 return $new_last_threadTrace unless ($old_last_threadTrace);
633 return $old_last_threadTrace;
636 sub session_threadTrace {
638 my $new_last_threadTrace = shift;
640 my $old_last_threadTrace = $self->{session_threadTrace};
641 if (defined $new_last_threadTrace) {
642 $self->{session_threadTrace} = $new_last_threadTrace;
643 return $new_last_threadTrace unless ($old_last_threadTrace);
646 return $old_last_threadTrace;
649 sub last_message_type {
651 my $new_last_message_type = shift;
653 my $old_last_message_type = $self->{last_message_type};
654 if (defined $new_last_message_type) {
655 $self->{last_message_type} = $new_last_message_type;
656 return $new_last_message_type unless ($old_last_message_type);
659 return $old_last_message_type;
662 sub last_message_api_level {
664 my $new_last_message_api_level = shift;
666 my $old_last_message_api_level = $self->{last_message_api_level};
667 if (defined $new_last_message_api_level) {
668 $self->{last_message_api_level} = $new_last_message_api_level;
669 return $new_last_message_api_level unless ($old_last_message_api_level);
672 return $old_last_message_api_level;
677 my $new_remote_id = shift;
679 my $old_remote_id = $self->{remote_id};
680 if (defined $new_remote_id) {
681 $self->{remote_id} = $new_remote_id;
682 return $new_remote_id unless ($old_remote_id);
685 return $old_remote_id;
693 my $old_ua = $self->{client_auth};
694 if (defined $new_ua) {
695 $self->{client_auth} = $new_ua;
696 return $new_ua unless ($old_ua);
699 return $old_ua->cloneNode(1);
704 my $new_state = shift;
706 my $old_state = $self->{state};
707 if (defined $new_state) {
708 $self->{state} = $new_state;
709 return $new_state unless ($old_state);
717 delete $$self{$_} for keys %$self;
727 if ( !(@proto_args % 2) ) {
729 } elsif (@proto_args == 1) {
730 %args = ( timeout => @proto_args );
734 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
736 if( exists( $args{timeout} ) ) {
737 $args{timeout} = int($args{timeout});
738 $self->{recv_timeout} = $args{timeout};
741 #$args{timeout} = 0 if ($self->complete);
743 if(defined($args{timeout})) {
744 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
747 my $avail = @{ $self->{recv_queue} };
748 $self->{remaining_recv_timeout} = $self->{recv_timeout};
752 $args{count} = $avail;
758 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
759 last if $self->complete;
760 my $starttime = time;
761 $self->queue_wait($self->{remaining_recv_timeout});
763 if ($self->{timeout_reset}) {
764 $self->{timeout_reset} = 0;
766 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
768 $avail = @{ $self->{recv_queue} };
771 $self->timed_out(1) if ( $self->{remaining_recv_timeout} <= 0 );
774 while ( my $msg = shift @{ $self->{recv_queue} } ) {
776 last if (scalar(@list) >= $args{count});
779 $logger->debug( "Number of matched responses: " . @list, DEBUG );
780 $self->queue_wait(0); # check for statuses
782 return $list[0] if (!wantarray);
789 $self->{timed_out} = $out if (defined $out);
790 return $self->{timed_out};
795 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
800 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
801 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
802 $req->resend unless $req->complete;
809 if( ! $self->{peer_handle} ) { return 0; }
810 my $timeout = shift || 0;
811 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
812 my $o = $self->{peer_handle}->process($timeout);
820 foreach my $msg ( @{$self->{recv_queue}} ) {
821 $string = $string . $msg->toString(1) . "\n";
829 $self->send( 'STATUS', @_ );
832 sub reset_request_timeout {
835 my $req = $self->app_request($tt);
836 $req->{remaining_recv_timeout} = $req->{recv_timeout};
837 $req->{timout_reset} = 1;
840 #-------------------------------------------------------------------------------
842 package OpenSRF::AppRequest;
843 use base qw/OpenSRF::AppSession/;
844 use OpenSRF::Utils::Logger qw/:level/;
845 use OpenSRF::DomainObject::oilsResponse qw/:status/;
846 use Time::HiRes qw/time usleep/;
850 $class = ref($class) || $class;
853 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
856 my $self = { session => $session,
857 threadTrace => $threadTrace,
861 max_bundle_count => 0,
862 current_bundle_count=> 0,
864 max_bundle_size => 0,
865 current_bundle_size => 0,
866 current_bundle => [],
869 remaining_recv_timeout => 30,
871 part_recv_buffer=> '',
874 bless $self => $class;
876 push @{ $self->session->{request_queue} }, $self;
881 sub max_bundle_count {
884 $self->{max_bundle_count} = $value if (defined($value));
885 return $self->{max_bundle_count};
888 sub max_bundle_size {
891 $self->{max_bundle_size} = $value if (defined($value));
892 return $self->{max_bundle_size};
898 $self->{max_chunk_size} = $value if (defined($value));
899 return $self->{max_chunk_size};
905 if (defined $timeout) {
906 $self->{recv_timeout} = $timeout;
907 $self->{remaining_recv_timeout} = $timeout;
909 return $self->{recv_timeout};
913 my $size = @{$_[0]->{recv_queue}};
919 return unless ($self and $self->session and !$self->complete);
920 $self->session->send(@_);
925 return unless $self->session;
926 $self->session->remove_app_request($self);
927 delete($$self{$_}) for (keys %$self);
931 return shift()->{session};
936 my $complete = shift;
937 return $self->{complete} if ($self->{complete});
938 if (defined $complete) {
939 $self->{complete} = $complete;
940 $self->{_duration} = time - $self->{_start} if ($self->{complete});
942 $self->session->queue_wait(0);
944 $self->completing(0) if ($self->{complete});
945 return $self->{complete};
951 $self->{_completing} = $value if (defined($value));
952 return $self->{_completing};
957 $self->wait_complete;
958 return $self->{_duration};
963 my $timeout = shift || 10;
964 my $time_remaining = $timeout;
966 while ( ! $self->complete and $time_remaining > 0 ) {
967 my $starttime = time;
968 $self->queue_wait($time_remaining);
970 $time_remaining -= ($endtime - $starttime);
973 return $self->complete;
977 return shift()->{threadTrace};
983 if( !$resp ) { return 0; }
984 if( UNIVERSAL::isa($resp, "Error")) {
985 $self->{failed} = $resp;
987 #return; eventually...
990 if( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::Partial")) {
991 $self->{part_recv_buffer} .= $resp->content;
993 } elsif( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::PartialComplete")) {
994 if ($self->{part_recv_buffer}) {
995 $resp = new OpenSRF::DomainObject::oilsResult;
996 $resp->content( OpenSRF::Utils::JSON->JSON2perl( $self->{part_recv_buffer} ) );
997 $self->{part_recv_buffer} = '';
1001 push @{ $self->{recv_queue} }, $resp;
1006 return $self->{failed};
1011 return $self->session->queue_wait(@_)
1014 sub payload { return shift()->{payload}; }
1018 return unless ($self and $self->session and !$self->complete);
1019 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
1020 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
1026 return unless ($self and $self->session and !$self->complete);
1027 $self->session->send( 'STATUS',$msg, $self->threadTrace );
1030 # TODO stream_push only works when server sessions can accept RESULT
1031 # messages, which is no longer supported. Create a new OpenSRF message
1032 # type to support client-to-server streams.
1036 # $self->respond( $msg );
1042 return unless ($self and $self->session and !$self->complete);
1044 my $type = 'RESULT';
1046 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResponse')) {
1048 $type = 'STATUS' if UNIVERSAL::isa($response, 'OpenSRF::DomainObject::oilsStatus');
1052 if ($self->max_chunk_size > 0) { # we might need to chunk
1053 my $str = OpenSRF::Utils::JSON->perl2JSON($msg);
1055 # XML can add a lot of length to a chunk due to escaping, so we
1056 # calculate chunk size based on an XML-escaped version of the message.
1057 # Example: If escaping doubles the length of the string then $ratio
1058 # will be 0.5 and we'll cut the chunk size for this message in half.
1060 my $raw_length = length($str);
1061 my $escaped_length = $raw_length;
1062 $escaped_length += 11 * (() = ( $str =~ /"/g)); # 7 \s and "
1063 $escaped_length += 4 * (() = ( $str =~ /&/g)); # &
1064 $escaped_length += 3 * (() = ( $str =~ /[<>]/g)); # < / >
1066 my $chunk_size = $self->max_chunk_size;
1068 if ($escaped_length > $self->max_chunk_size) {
1069 $chunk_size = ($raw_length / $escaped_length) * $self->max_chunk_size;
1072 if ($raw_length > $chunk_size) { # send partials ("chunking")
1073 for (my $i = 0; $i < length($str); $i += $chunk_size) {
1074 $response = new OpenSRF::DomainObject::oilsResult::Partial;
1075 $response->content( substr($str, $i, $chunk_size) );
1076 $self->session->send($type, $response, $self->threadTrace);
1078 # This triggers reconstruction on the remote end
1079 $response = new OpenSRF::DomainObject::oilsResult::PartialComplete;
1080 return $self->session->send($type, $response, $self->threadTrace);
1084 # message failed to exceed max chunk size OR chunking disabled
1085 $response = new OpenSRF::DomainObject::oilsResult;
1086 $response->content($msg);
1089 if ($self->{max_bundle_count} > 0 or $self->{max_bundle_size} > 0) { # we are bundling, and we need to test the size or count
1091 $self->{current_bundle_size} += length(OpenSRF::Utils::JSON->perl2JSON($response));
1092 push @{$self->{current_bundle}}, $type, $response;
1093 $self->{current_bundle_count}++;
1095 if ( $self->completing ||
1096 ($self->{max_bundle_size} && $self->{current_bundle_size} >= $self->{max_bundle_size} ) ||
1097 ($self->{max_bundle_count} && $self->{current_bundle_count} >= $self->{max_bundle_count})
1098 ) { # send chunk and reset
1099 my $send_res = $self->session->send( @{$self->{current_bundle}}, $self->threadTrace);
1100 $self->{current_bundle} = [];
1101 $self->{current_bundle_size} = 0;
1102 $self->{current_bundle_count} = 0;
1104 } else { # not at a chunk yet, just queue it up
1105 return $self->session->app_request( $self->threadTrace );
1109 $self->session->send($type, $response, $self->threadTrace);
1112 sub respond_complete {
1115 return unless ($self and $self->session and !$self->complete);
1117 $self->respond($msg) if (defined($msg));
1119 $self->completing(1);
1121 OpenSRF::DomainObject::oilsConnectStatus->new(
1122 statusCode => STATUS_COMPLETE(),
1123 status => 'Request Complete'
1129 sub register_death_callback {
1132 $self->session->register_callback( death => $cb );
1136 # utility method. checks to see of the request failed.
1137 # if so, throws an OpenSRF::EX::ERROR. if everything is
1138 # ok, it returns the content of the request
1142 $self->wait_complete;
1143 my $resp = $self->recv( timeout => 60 );
1144 if( $self->failed() ) {
1145 throw OpenSRF::EX::ERROR
1146 ($self->failed()->stringify());
1148 if(!$resp) { return undef; }
1149 my $content = $resp->content;
1150 if($finish) { $self->finish();}
1155 package OpenSRF::AppSubrequest;
1156 use base 'OpenSRF::AppRequest';
1160 return if $self->complete;
1163 return $self->SUPER::respond($resp) if $self->respond_directly;
1165 push @{$$self{resp}}, $resp if (defined $resp);
1168 sub respond_complete {
1170 return $self->SUPER::respond_complete(@_) if $self->respond_directly;
1177 $class = ref($class) || $class;
1180 respond_directly=> 0, # use the passed session directly (RD mode)
1182 threadTrace => 0, # needed for respond in RD mode
1183 max_chunk_count => 0, # needed for respond in RD mode
1184 max_chunk_size => 0, # needed for respond in RD mode
1185 max_bundle_size => 0,
1186 current_bundle => [], # needed for respond_complete in RD mode
1187 current_bundle_count=> 0,
1188 current_bundle_size => 0,
1189 max_bundle_count => 0,
1192 if ($self->session) {
1193 # steal the thread trace from the parent session for RD mode
1194 $self->{threadTrace} = $self->session->session_threadTrace || $self->session->last_threadTrace;
1199 sub responses { @{$_[0]->{resp}} }
1201 sub respond_directly {
1204 $x->{respond_directly} = $s if (defined $s);
1205 return $x->session && $x->{respond_directly};
1211 $x->{session} = $s if ($s);
1212 return $x->{session};
1218 $x->{complete} = $c if ($c);
1219 $x->completing(0) if ($c);
1220 return $x->{complete};
1226 $self->{_completing} = $value if (defined($value));
1227 return $self->{_completing};