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;
14 use base qw/Exporter OpenSRF/;
15 use Time::HiRes qw( time usleep );
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/ ],
24 my $logger = "OpenSRF::Utils::Logger";
25 my $_last_locale = 'en-US';
26 our $current_ingress = 'opensrf';
28 # Get/set the locale used by all new client sessions
29 # for the current process. This is primarily useful
30 # for clients that wish to make a series of opensrf
31 # calls and don't wish to set the locale for each new
34 # The caller should reset the locale when done using
35 # reset_locale(), as the locale will otherwise persist
36 # for the current process until set/reset again.
38 # This is not for SERVER processes, since they
39 # adopt the locale of their respective callers.
41 my ($class, $locale) = @_;
42 $_last_locale = $locale if $locale;
47 return $_last_locale = 'en-US';
51 my ($class, $ingress) = @_;
52 $current_ingress = $ingress if $ingress;
53 return $current_ingress;
59 sub CONNECTING { return 3 };
60 sub INIT_CONNECTED { return 4 };
61 sub CONNECTED { return 1 };
62 sub DISCONNECTED { return 2 };
64 sub CLIENT { return 2 };
65 sub SERVER { return 1 };
68 return undef unless (defined $_[1]);
69 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
72 sub transport_connected {
74 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
77 return $self->{peer_handle}->tcp_connected();
82 return $self->state == CONNECTED;
84 # ----------------------------------------------------------------------------
85 # Clears the transport buffers
86 # call this if you are not through with the sesssion, but you want
87 # to have a clean slate. You shouldn't have to call this if
88 # you are correctly 'recv'ing all of the data from a request.
89 # however, if you don't want all of the data, this will
90 # slough off any excess
91 # * * Note: This will delete data for all sessions using this transport
92 # handle. For example, all client sessions use the same handle.
93 # ----------------------------------------------------------------------------
97 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
100 $self->{peer_handle}->buffer_reset();
104 # when any incoming data is received, this method is called.
107 $class = ref($class) || $class;
110 my $remote_id = shift;
113 warn "Missing args to server_build():\n" .
114 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
115 unless ($sess_id and $remote_id and $service);
117 return undef unless ($sess_id and $remote_id and $service);
119 if ( my $thingy = $class->find($sess_id) ) {
120 $thingy->remote_id( $remote_id );
124 if( $service eq "client" ) {
125 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
126 # " Session ID [$sess_id], remote_id [$remote_id]");
128 warn "Attempting to build a client session as ".
129 "a server Session ID [$sess_id], remote_id [$remote_id]";
131 $logger->debug("Attempting to build a client session as ".
132 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
137 my $config_client = OpenSRF::Utils::SettingsClient->new();
138 my $stateless = $config_client->config_value("apps", $service, "stateless");
140 #my $max_requests = $conf->$service->max_requests;
141 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
142 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
144 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
146 my $self = bless { recv_queue => [],
153 session_id => $sess_id,
154 remote_id => $remote_id,
155 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
156 max_requests => $max_requests,
157 session_threadTrace => 0,
159 stateless => $stateless,
162 return $_CACHE{$sess_id} = $self;
167 my ($name, $datum) = @_;
169 $self->{session_data}->{$name} = $datum if (defined $datum);
170 return $self->{session_data}->{$name};
173 sub service { return shift()->{service}; }
175 sub continue_request {
177 $self->{'requests'}++;
178 return 1 if (!$self->{'max_requests'});
179 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
182 sub last_sent_payload {
183 my( $self, $payload ) = @_;
185 return $self->{'last_sent_payload'} = $payload;
187 return $self->{'last_sent_payload'};
191 my( $self, $type ) = @_;
193 $_last_locale = $type if ($self->endpoint == SERVER);
194 return $self->{'session_locale'} = $type;
196 return $self->{'session_locale'};
200 my( $self, $type ) = @_;
202 return $self->{'last_sent_type'} = $type;
204 return $self->{'last_sent_type'};
207 sub get_app_targets {
210 my $conf = OpenSRF::Utils::Config->current;
211 my $router_name = $conf->bootstrap->router_name || 'router';
212 my $domain = $conf->bootstrap->domain;
213 $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
215 unless($router_name and $domain) {
216 throw OpenSRF::EX::Config
217 ("Missing router config information 'router_name' and 'domain'");
220 return ("$router_name\@$domain/$app");
226 $self->{stateless} = $state if (defined $state);
227 return $self->{stateless};
230 # When we're a client and we want to connect to a remote service
233 $class = ref($class) || $class;
236 my $api_level = shift;
238 my $locale = shift || $_last_locale;
240 $api_level = 1 if (!defined($api_level));
242 $logger->debug( "AppSession creating new client session for $app", DEBUG );
245 my $c = OpenSRF::Utils::SettingsClient->new();
246 # we can get an infinite loop if we're grabbing the settings and we
247 # need the settings to grab the settings...
248 if($app ne "opensrf.settings" || $c->has_config()) {
249 $stateless = $c->config_value("apps", $app, "stateless");
252 my $sess_id = time . rand( $$ );
253 while ( $class->find($sess_id) ) {
254 $sess_id = time . rand( $$ );
258 my ($r_id) = get_app_targets($app);
260 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
261 if( ! $peer_handle ) {
262 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
265 my $self = bless { app_name => $app,
268 state => DISCONNECTED,#since we're init'ing
269 session_id => $sess_id,
271 raise_error => $quiet ? 0 : 1,
272 session_locale => $locale,
273 api_level => $api_level,
274 orig_remote_id => $r_id,
275 peer_handle => $peer_handle,
276 session_threadTrace => 0,
277 stateless => $stateless,
280 $logger->debug( "Created new client session $app : $sess_id" );
282 return $_CACHE{$sess_id} = $self;
285 sub raise_remote_errors {
288 $self->{raise_error} = $err if (defined $err);
289 return $self->{raise_error};
293 return shift()->{api_level};
297 return shift()->{app_name};
302 $self->remote_id($$self{orig_remote_id});
305 # 'connect' can be used as a constructor if called as a class method,
306 # or used to connect a session that has disconnectd if called against
307 # an existing session that seems to be disconnected, or was just built
308 # using 'create' above.
310 # connect( $app, username => $user, secret => $passwd );
312 # connect( $app, sysname => $user, secret => $shared_secret );
314 # --- Returns undef if the connect attempt times out.
315 # --- Returns the OpenSRF::EX object if one is returned by the server
316 # --- Returns self if connected
319 my $class = ref($self) || $self;
322 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
323 $logger->transport("AppSession already connected", DEBUG );
325 $logger->transport("AppSession not connected, connecting..", DEBUG );
327 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
331 my $api_level = shift;
332 $api_level = 1 unless (defined $api_level);
334 $self = $class->create($app, @_) if (!ref($self));
336 return undef unless ($self);
338 $self->{api_level} = $api_level;
341 $self->state(CONNECTING);
342 $self->send('CONNECT', "");
345 # if we want to connect to settings, we may not have
346 # any data for the settings client to work with...
347 # just using a default for now XXX
349 my $time_remaining = 5;
352 # my $client = OpenSRF::Utils::SettingsClient->new();
353 # my $trans = $client->config_value("client_connection","transport_host");
356 # $time_remaining = $trans->{connect_timeout};
358 # # XXX for now, just use the first
359 # $time_remaining = $trans->[0]->{connect_timeout};
362 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
363 my $starttime = time;
364 $self->queue_wait($time_remaining);
366 $time_remaining -= ($endtime - $starttime);
369 return undef unless($self->state == CONNECTED);
378 if( ! $self->session_id ) {
383 sub unregister_callback {
387 if (exists $self->{callbacks}{$type}) {
388 delete $self->{callbacks}{$type}{$cb};
394 sub register_callback {
399 $self->{callbacks}{$type}{$cb_key} = $cb;
405 if( ! $self->session_id ) { return 0; }
407 # run each 'death' callback;
408 if (exists $self->{callbacks}{death}) {
409 for my $sub (values %{$self->{callbacks}{death}}) {
415 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
416 delete $_CACHE{$self->session_id};
417 delete($$self{$_}) for (keys %$self);
423 # run each 'disconnect' callback;
424 if (exists $self->{callbacks}{disconnect}) {
425 for my $sub (values %{$self->{callbacks}{disconnect}}) {
430 if ( !$self->stateless and $self->state != DISCONNECTED ) {
431 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
432 $self->state( DISCONNECTED );
443 # tell the logger to create a new xid - the logger will decide if it's really necessary
444 $logger->mk_osrf_xid;
448 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
453 $method->params( @_ );
455 $self->send('REQUEST',$method);
464 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
469 $method->params( @_ );
471 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
476 my @payload_list = @_; # this is a Domain Object
478 return unless ($self and $self->{peer_handle});
480 $logger->debug( "In send", INTERNAL );
484 if( @payload_list % 2 ) { $tT = pop @payload_list; }
486 if( ! @payload_list ) {
487 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
496 while( @payload_list ) {
498 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
500 if ($msg_type eq 'DISCONNECT' ) {
502 if( $self->state == DISCONNECTED && !$connecting) {
507 if( $msg_type eq "CONNECT" ) {
511 my $msg = OpenSRF::DomainObject::oilsMessage->new();
512 $msg->type($msg_type);
515 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
518 if ($msg->type eq 'REQUEST') {
519 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
520 $msg->update_threadTrace;
521 $self->session_threadTrace( $msg->threadTrace );
522 $tT = $self->session_threadTrace;
523 OpenSRF::AppRequest->new($self, $payload);
527 $msg->api_level($self->api_level);
528 $msg->payload($payload) if $payload;
530 my $locale = $self->session_locale;
531 $msg->sender_locale($locale) if ($locale);
533 $msg->sender_ingress($current_ingress);
538 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
539 " with threadTrace [".$msg->threadTrace."]");
543 if ($self->endpoint == CLIENT and ! $disconnect) {
544 $self->queue_wait(0);
547 if($self->stateless && $self->state != CONNECTED) {
549 $logger->debug("AppSession is stateless in send", INTERNAL );
552 if( !$self->stateless and $self->state != CONNECTED ) {
554 $logger->debug( "Sending connect before request 1", INTERNAL );
556 unless (($self->state == CONNECTING && $connecting )) {
557 $logger->debug( "Sending connect before request 2", INTERNAL );
558 my $v = $self->connect();
560 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
563 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
570 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
571 $logger->internal("AppSession sending doc: $json");
573 $self->{peer_handle}->send(
574 to => $self->remote_id,
575 thread => $self->session_id,
579 $self->state( DISCONNECTED );
582 my $req = $self->app_request( $tT );
583 $req->{_start} = time;
591 return undef unless (defined $tT);
592 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
597 sub remove_app_request {
601 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
603 $self->{request_queue} = \@list;
607 return $_[0]->{endpoint};
613 return $self->{session_id};
619 my $req = $self->app_request($resp->[1]);
620 return $req->push_queue( $resp->[0] ) if ($req);
621 push @{ $self->{recv_queue} }, $resp->[0];
624 sub last_threadTrace {
626 my $new_last_threadTrace = shift;
628 my $old_last_threadTrace = $self->{last_threadTrace};
629 if (defined $new_last_threadTrace) {
630 $self->{last_threadTrace} = $new_last_threadTrace;
631 return $new_last_threadTrace unless ($old_last_threadTrace);
634 return $old_last_threadTrace;
637 sub session_threadTrace {
639 my $new_last_threadTrace = shift;
641 my $old_last_threadTrace = $self->{session_threadTrace};
642 if (defined $new_last_threadTrace) {
643 $self->{session_threadTrace} = $new_last_threadTrace;
644 return $new_last_threadTrace unless ($old_last_threadTrace);
647 return $old_last_threadTrace;
650 sub last_message_type {
652 my $new_last_message_type = shift;
654 my $old_last_message_type = $self->{last_message_type};
655 if (defined $new_last_message_type) {
656 $self->{last_message_type} = $new_last_message_type;
657 return $new_last_message_type unless ($old_last_message_type);
660 return $old_last_message_type;
663 sub last_message_api_level {
665 my $new_last_message_api_level = shift;
667 my $old_last_message_api_level = $self->{last_message_api_level};
668 if (defined $new_last_message_api_level) {
669 $self->{last_message_api_level} = $new_last_message_api_level;
670 return $new_last_message_api_level unless ($old_last_message_api_level);
673 return $old_last_message_api_level;
678 my $new_remote_id = shift;
680 my $old_remote_id = $self->{remote_id};
681 if (defined $new_remote_id) {
682 $self->{remote_id} = $new_remote_id;
683 return $new_remote_id unless ($old_remote_id);
686 return $old_remote_id;
694 my $old_ua = $self->{client_auth};
695 if (defined $new_ua) {
696 $self->{client_auth} = $new_ua;
697 return $new_ua unless ($old_ua);
700 return $old_ua->cloneNode(1);
705 my $new_state = shift;
707 my $old_state = $self->{state};
708 if (defined $new_state) {
709 $self->{state} = $new_state;
710 return $new_state unless ($old_state);
718 delete $$self{$_} for keys %$self;
728 if ( !(@proto_args % 2) ) {
730 } elsif (@proto_args == 1) {
731 %args = ( timeout => @proto_args );
735 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
737 if( exists( $args{timeout} ) ) {
738 $args{timeout} = int($args{timeout});
739 $self->{recv_timeout} = $args{timeout};
742 #$args{timeout} = 0 if ($self->complete);
744 if(defined($args{timeout})) {
745 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
748 my $avail = @{ $self->{recv_queue} };
749 $self->{remaining_recv_timeout} = $self->{recv_timeout};
753 $args{count} = $avail;
759 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
760 last if $self->complete;
761 my $starttime = time;
762 $self->queue_wait($self->{remaining_recv_timeout});
764 if ($self->{timeout_reset}) {
765 $self->{timeout_reset} = 0;
767 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
769 $avail = @{ $self->{recv_queue} };
772 $self->timed_out(1) if ( $self->{remaining_recv_timeout} <= 0 );
775 while ( my $msg = shift @{ $self->{recv_queue} } ) {
777 last if (scalar(@list) >= $args{count});
780 $logger->debug( "Number of matched responses: " . @list, DEBUG );
781 $self->queue_wait(0); # check for statuses
783 return $list[0] if (!wantarray);
790 $self->{timed_out} = $out if (defined $out);
791 return $self->{timed_out};
796 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
801 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
802 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
803 $req->resend unless $req->complete;
810 if( ! $self->{peer_handle} ) { return 0; }
811 my $timeout = shift || 0;
812 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
813 my $o = $self->{peer_handle}->process($timeout);
821 foreach my $msg ( @{$self->{recv_queue}} ) {
822 $string = $string . $msg->toString(1) . "\n";
830 $self->send( 'STATUS', @_ );
833 sub reset_request_timeout {
836 my $req = $self->app_request($tt);
837 $req->{remaining_recv_timeout} = $req->{recv_timeout};
838 $req->{timout_reset} = 1;
841 #-------------------------------------------------------------------------------
843 package OpenSRF::AppRequest;
844 use base qw/OpenSRF::AppSession/;
845 use OpenSRF::Utils::Logger qw/:level/;
846 use OpenSRF::DomainObject::oilsResponse qw/:status/;
847 use Time::HiRes qw/time usleep/;
851 $class = ref($class) || $class;
854 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
857 my $self = { session => $session,
858 threadTrace => $threadTrace,
862 max_bundle_count => 0,
863 current_bundle_count=> 0,
865 max_bundle_size => 0,
866 current_bundle_size => 0,
867 current_bundle => [],
870 remaining_recv_timeout => 30,
872 part_recv_buffer=> '',
875 bless $self => $class;
877 push @{ $self->session->{request_queue} }, $self;
882 sub max_bundle_count {
885 $self->{max_bundle_count} = $value if (defined($value));
886 return $self->{max_bundle_count};
889 sub max_bundle_size {
892 $self->{max_bundle_size} = $value if (defined($value));
893 return $self->{max_bundle_size};
899 $self->{max_chunk_size} = $value if (defined($value));
900 return $self->{max_chunk_size};
906 if (defined $timeout) {
907 $self->{recv_timeout} = $timeout;
908 $self->{remaining_recv_timeout} = $timeout;
910 return $self->{recv_timeout};
914 my $size = @{$_[0]->{recv_queue}};
920 return unless ($self and $self->session and !$self->complete);
921 $self->session->send(@_);
926 return unless $self->session;
927 $self->session->remove_app_request($self);
928 delete($$self{$_}) for (keys %$self);
932 return shift()->{session};
937 my $complete = shift;
938 return $self->{complete} if ($self->{complete});
939 if (defined $complete) {
940 $self->{complete} = $complete;
941 $self->{_duration} = time - $self->{_start} if ($self->{complete});
943 $self->session->queue_wait(0);
945 $self->completing(0) if ($self->{complete});
946 return $self->{complete};
952 $self->{_completing} = $value if (defined($value));
953 return $self->{_completing};
958 $self->wait_complete;
959 return $self->{_duration};
964 my $timeout = shift || 10;
965 my $time_remaining = $timeout;
967 while ( ! $self->complete and $time_remaining > 0 ) {
968 my $starttime = time;
969 $self->queue_wait($time_remaining);
971 $time_remaining -= ($endtime - $starttime);
974 return $self->complete;
978 return shift()->{threadTrace};
984 if( !$resp ) { return 0; }
985 if( UNIVERSAL::isa($resp, "Error")) {
986 $self->{failed} = $resp;
988 #return; eventually...
991 if( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::Partial")) {
992 $self->{part_recv_buffer} .= $resp->content;
994 } elsif( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::PartialComplete")) {
995 if ($self->{part_recv_buffer}) {
996 $resp = new OpenSRF::DomainObject::oilsResult;
997 $resp->content( OpenSRF::Utils::JSON->JSON2perl( $self->{part_recv_buffer} ) );
998 $self->{part_recv_buffer} = '';
1002 push @{ $self->{recv_queue} }, $resp;
1007 return $self->{failed};
1012 return $self->session->queue_wait(@_)
1015 sub payload { return shift()->{payload}; }
1019 return unless ($self and $self->session and !$self->complete);
1020 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
1021 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
1027 return unless ($self and $self->session and !$self->complete);
1028 $self->session->send( 'STATUS',$msg, $self->threadTrace );
1031 # TODO stream_push only works when server sessions can accept RESULT
1032 # messages, which is no longer supported. Create a new OpenSRF message
1033 # type to support client-to-server streams.
1037 # $self->respond( $msg );
1043 return unless ($self and $self->session and !$self->complete);
1045 my $type = 'RESULT';
1047 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResponse')) {
1049 $type = 'STATUS' if UNIVERSAL::isa($response, 'OpenSRF::DomainObject::oilsStatus');
1053 if ($self->max_chunk_size > 0) { # we might need to chunk
1054 my $str = OpenSRF::Utils::JSON->perl2JSON($msg);
1056 # XML can add a lot of length to a chunk due to escaping, so we
1057 # calculate chunk size based on an XML-escaped version of the message.
1058 # Example: If escaping doubles the length of the string then $ratio
1059 # will be 0.5 and we'll cut the chunk size for this message in half.
1061 my $raw_length = length(Encode::encode_utf8($str)); # count bytes
1062 my $escaped_length = $raw_length;
1063 $escaped_length += 11 * (() = ( $str =~ /"/g)); # 7 \s and "
1064 $escaped_length += 4 * (() = ( $str =~ /&/g)); # &
1065 $escaped_length += 3 * (() = ( $str =~ /[<>]/g)); # < / >
1067 my $chunk_size = $self->max_chunk_size;
1069 if ($escaped_length > $self->max_chunk_size) {
1070 $chunk_size = ($raw_length / $escaped_length) * $self->max_chunk_size;
1073 if ($raw_length > $chunk_size) { # send partials ("chunking")
1074 my $num_bytes = length(Encode::encode_utf8($str));
1075 for (my $i = 0; $i < $num_bytes; $i += $chunk_size) {
1076 $response = new OpenSRF::DomainObject::oilsResult::Partial;
1077 $response->content( substr($str, $i, $chunk_size) );
1078 $self->session->send($type, $response, $self->threadTrace);
1080 # This triggers reconstruction on the remote end
1081 $response = new OpenSRF::DomainObject::oilsResult::PartialComplete;
1082 return $self->session->send($type, $response, $self->threadTrace);
1086 # message failed to exceed max chunk size OR chunking disabled
1087 $response = new OpenSRF::DomainObject::oilsResult;
1088 $response->content($msg);
1091 if ($self->{max_bundle_count} > 0 or $self->{max_bundle_size} > 0) { # we are bundling, and we need to test the size or count
1093 $self->{current_bundle_size} += length(
1094 Encode::encode_utf8(OpenSRF::Utils::JSON->perl2JSON($response)));
1095 push @{$self->{current_bundle}}, $type, $response;
1096 $self->{current_bundle_count}++;
1098 if ( $self->completing ||
1099 ($self->{max_bundle_size} && $self->{current_bundle_size} >= $self->{max_bundle_size} ) ||
1100 ($self->{max_bundle_count} && $self->{current_bundle_count} >= $self->{max_bundle_count})
1101 ) { # send chunk and reset
1102 my $send_res = $self->session->send( @{$self->{current_bundle}}, $self->threadTrace);
1103 $self->{current_bundle} = [];
1104 $self->{current_bundle_size} = 0;
1105 $self->{current_bundle_count} = 0;
1107 } else { # not at a chunk yet, just queue it up
1108 return $self->session->app_request( $self->threadTrace );
1112 $self->session->send($type, $response, $self->threadTrace);
1115 sub respond_complete {
1118 return unless ($self and $self->session and !$self->complete);
1120 $self->respond($msg) if (defined($msg));
1122 $self->completing(1);
1124 OpenSRF::DomainObject::oilsConnectStatus->new(
1125 statusCode => STATUS_COMPLETE(),
1126 status => 'Request Complete'
1132 sub register_death_callback {
1135 $self->session->register_callback( death => $cb );
1139 # utility method. checks to see of the request failed.
1140 # if so, throws an OpenSRF::EX::ERROR. if everything is
1141 # ok, it returns the content of the request
1145 $self->wait_complete;
1146 my $resp = $self->recv( timeout => 60 );
1147 if( $self->failed() ) {
1148 throw OpenSRF::EX::ERROR
1149 ($self->failed()->stringify());
1151 if(!$resp) { return undef; }
1152 my $content = $resp->content;
1153 if($finish) { $self->finish();}
1158 package OpenSRF::AppSubrequest;
1159 use base 'OpenSRF::AppRequest';
1163 return if $self->complete;
1166 return $self->SUPER::respond($resp) if $self->respond_directly;
1168 push @{$$self{resp}}, $resp if (defined $resp);
1171 sub respond_complete {
1173 return $self->SUPER::respond_complete(@_) if $self->respond_directly;
1180 $class = ref($class) || $class;
1183 respond_directly=> 0, # use the passed session directly (RD mode)
1185 threadTrace => 0, # needed for respond in RD mode
1186 max_chunk_count => 0, # needed for respond in RD mode
1187 max_chunk_size => 0, # needed for respond in RD mode
1188 max_bundle_size => 0,
1189 current_bundle => [], # needed for respond_complete in RD mode
1190 current_bundle_count=> 0,
1191 current_bundle_size => 0,
1192 max_bundle_count => 0,
1195 if ($self->session) {
1196 # steal the thread trace from the parent session for RD mode
1197 $self->{threadTrace} = $self->session->session_threadTrace || $self->session->last_threadTrace;
1202 sub responses { @{$_[0]->{resp}} }
1204 sub respond_directly {
1207 $x->{respond_directly} = $s if (defined $s);
1208 return $x->session && $x->{respond_directly};
1214 $x->{session} = $s if ($s);
1215 return $x->{session};
1221 $x->{complete} = $c if ($c);
1222 $x->completing(0) if ($c);
1223 return $x->{complete};
1229 $self->{_completing} = $value if (defined($value));
1230 return $self->{_completing};