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 );
20 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
21 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
22 endpoint => [ qw/CLIENT SERVER/ ],
25 my $logger = "OpenSRF::Utils::Logger";
26 my $_last_locale = 'en-US';
27 our $current_ingress = 'opensrf';
29 # Get/set the locale used by all new client sessions
30 # for the current process. This is primarily useful
31 # for clients that wish to make a series of opensrf
32 # calls and don't wish to set the locale for each new
35 # The caller should reset the locale when done using
36 # reset_locale(), as the locale will otherwise persist
37 # for the current process until set/reset again.
39 # This is not for SERVER processes, since they
40 # adopt the locale of their respective callers.
42 my ($class, $locale) = @_;
43 $_last_locale = $locale if $locale;
48 return $_last_locale = 'en-US';
52 my ($class, $ingress) = @_;
53 $current_ingress = $ingress if $ingress;
54 return $current_ingress;
60 sub CONNECTING { return 3 };
61 sub INIT_CONNECTED { return 4 };
62 sub CONNECTED { return 1 };
63 sub DISCONNECTED { return 2 };
65 sub CLIENT { return 2 };
66 sub SERVER { return 1 };
69 return undef unless (defined $_[1]);
70 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
73 sub transport_connected {
75 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
78 return $self->{peer_handle}->tcp_connected();
83 return $self->state == CONNECTED;
85 # ----------------------------------------------------------------------------
86 # Clears the transport buffers
87 # call this if you are not through with the sesssion, but you want
88 # to have a clean slate. You shouldn't have to call this if
89 # you are correctly 'recv'ing all of the data from a request.
90 # however, if you don't want all of the data, this will
91 # slough off any excess
92 # * * Note: This will delete data for all sessions using this transport
93 # handle. For example, all client sessions use the same handle.
94 # ----------------------------------------------------------------------------
98 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
101 $self->{peer_handle}->buffer_reset();
105 # when any incoming data is received, this method is called.
108 $class = ref($class) || $class;
111 my $remote_id = shift;
114 warn "Missing args to server_build():\n" .
115 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
116 unless ($sess_id and $remote_id and $service);
118 return undef unless ($sess_id and $remote_id and $service);
120 if ( my $thingy = $class->find($sess_id) ) {
121 $thingy->remote_id( $remote_id );
125 if( $service eq "client" ) {
126 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
127 # " Session ID [$sess_id], remote_id [$remote_id]");
129 warn "Attempting to build a client session as ".
130 "a server Session ID [$sess_id], remote_id [$remote_id]";
132 $logger->debug("Attempting to build a client session as ".
133 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
138 my $config_client = OpenSRF::Utils::SettingsClient->new();
139 my $stateless = $config_client->config_value("apps", $service, "stateless");
141 #my $max_requests = $conf->$service->max_requests;
142 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
143 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
145 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
147 my $self = bless { recv_queue => [],
155 session_id => $sess_id,
156 remote_id => $remote_id,
157 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
158 max_requests => $max_requests,
159 session_threadTrace => 0,
161 stateless => $stateless,
164 return $_CACHE{$sess_id} = $self;
169 my ($name, $datum) = @_;
171 $self->{session_data}->{$name} = $datum if (defined $datum);
172 return $self->{session_data}->{$name};
175 sub service { return shift()->{service}; }
177 sub continue_request {
179 $self->{'requests'}++;
180 return 1 if (!$self->{'max_requests'});
181 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
184 sub last_sent_payload {
185 my( $self, $payload ) = @_;
187 return $self->{'last_sent_payload'} = $payload;
189 return $self->{'last_sent_payload'};
193 my( $self, $type ) = @_;
195 $_last_locale = $type if ($self->endpoint == SERVER);
196 return $self->{'session_locale'} = $type;
198 return $self->{'session_locale'};
202 my( $self, $type ) = @_;
204 return $self->{'last_sent_type'} = $type;
206 return $self->{'last_sent_type'};
209 sub get_app_targets {
212 my $conf = OpenSRF::Utils::Config->current;
213 my $router_name = $conf->bootstrap->router_name || 'router';
214 my $domain = $conf->bootstrap->domain;
215 $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
217 unless($router_name and $domain) {
218 throw OpenSRF::EX::Config
219 ("Missing router config information 'router_name' and 'domain'");
222 return ("$router_name\@$domain/$app");
228 $self->{stateless} = $state if (defined $state);
229 return $self->{stateless};
232 # When true, indicates the server drone should be killed (recycled)
233 # after the current session has completed. This overrides the
234 # configured max_request value.
236 my ($self, $force) = @_;
237 $self->{force_recycle} = $force if defined $force;
238 return $self->{force_recycle};
241 # When we're a client and we want to connect to a remote service
244 $class = ref($class) || $class;
247 my $api_level = shift;
249 my $locale = shift || $_last_locale;
251 $api_level = 1 if (!defined($api_level));
253 $logger->debug( "AppSession creating new client session for $app", DEBUG );
256 my $c = OpenSRF::Utils::SettingsClient->new();
257 # we can get an infinite loop if we're grabbing the settings and we
258 # need the settings to grab the settings...
259 if($app ne "opensrf.settings" || $c->has_config()) {
260 $stateless = $c->config_value("apps", $app, "stateless");
263 my $sess_id = time . rand( $$ );
264 while ( $class->find($sess_id) ) {
265 $sess_id = time . rand( $$ );
269 my ($r_id) = get_app_targets($app);
271 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
272 if( ! $peer_handle ) {
273 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
276 my $self = bless { app_name => $app,
279 state => DISCONNECTED,#since we're init'ing
280 session_id => $sess_id,
282 raise_error => $quiet ? 0 : 1,
283 session_locale => $locale,
284 api_level => $api_level,
285 orig_remote_id => $r_id,
286 peer_handle => $peer_handle,
287 session_threadTrace => 0,
288 stateless => $stateless,
291 $logger->debug( "Created new client session $app : $sess_id" );
293 return $_CACHE{$sess_id} = $self;
296 sub raise_remote_errors {
299 $self->{raise_error} = $err if (defined $err);
300 return $self->{raise_error};
304 return shift()->{api_level};
308 return shift()->{app_name};
313 $self->remote_id($$self{orig_remote_id});
316 # 'connect' can be used as a constructor if called as a class method,
317 # or used to connect a session that has disconnectd if called against
318 # an existing session that seems to be disconnected, or was just built
319 # using 'create' above.
321 # connect( $app, username => $user, secret => $passwd );
323 # connect( $app, sysname => $user, secret => $shared_secret );
325 # --- Returns undef if the connect attempt times out.
326 # --- Returns the OpenSRF::EX object if one is returned by the server
327 # --- Returns self if connected
330 my $class = ref($self) || $self;
333 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
334 $logger->transport("AppSession already connected", DEBUG );
336 $logger->transport("AppSession not connected, connecting..", DEBUG );
338 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
342 my $api_level = shift;
343 $api_level = 1 unless (defined $api_level);
345 $self = $class->create($app, @_) if (!ref($self));
347 return undef unless ($self);
349 $self->{api_level} = $api_level;
352 $self->state(CONNECTING);
353 $self->send('CONNECT', "");
356 # if we want to connect to settings, we may not have
357 # any data for the settings client to work with...
358 # just using a default for now XXX
360 my $time_remaining = 5;
363 # my $client = OpenSRF::Utils::SettingsClient->new();
364 # my $trans = $client->config_value("client_connection","transport_host");
367 # $time_remaining = $trans->{connect_timeout};
369 # # XXX for now, just use the first
370 # $time_remaining = $trans->[0]->{connect_timeout};
373 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
374 my $starttime = time;
375 $self->queue_wait($time_remaining);
377 $time_remaining -= ($endtime - $starttime);
380 return undef unless($self->state == CONNECTED);
389 if( ! $self->session_id ) {
394 sub unregister_callback {
398 if (exists $self->{callbacks}{$type}) {
399 delete $self->{callbacks}{$type}{$cb};
405 sub register_callback {
410 $self->{callbacks}{$type}{$cb_key} = $cb;
416 if( ! $self->session_id ) { return 0; }
418 # run each 'death' callback;
419 if (exists $self->{callbacks}{death}) {
420 for my $sub (values %{$self->{callbacks}{death}}) {
426 $logger->transport(sub{return "AppSession killing self: " . $self->session_id() }, DEBUG );
427 delete $_CACHE{$self->session_id};
428 delete($$self{$_}) for (keys %$self);
434 # run each 'disconnect' callback;
435 if (exists $self->{callbacks}{disconnect}) {
436 for my $sub (values %{$self->{callbacks}{disconnect}}) {
441 if ( !$self->stateless and $self->state != DISCONNECTED ) {
442 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
443 $self->state( DISCONNECTED );
454 # tell the logger to create a new xid - the logger will decide if it's really necessary
455 $logger->mk_osrf_xid;
459 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
464 $method->params( @_ );
466 $self->send('REQUEST',$method);
475 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
480 $method->params( @_ );
482 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
487 my @payload_list = @_; # this is a Domain Object
489 return unless ($self and $self->{peer_handle});
491 $logger->debug( "In send", INTERNAL );
495 if( @payload_list % 2 ) { $tT = pop @payload_list; }
497 if( ! @payload_list ) {
498 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
507 while( @payload_list ) {
509 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
511 if ($msg_type eq 'DISCONNECT' ) {
513 if( $self->state == DISCONNECTED && !$connecting) {
518 if( $msg_type eq "CONNECT" ) {
522 my $msg = OpenSRF::DomainObject::oilsMessage->new();
523 $msg->type($msg_type);
526 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
529 if ($msg->type eq 'REQUEST') {
530 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
531 $msg->update_threadTrace;
532 $self->session_threadTrace( $msg->threadTrace );
533 $tT = $self->session_threadTrace;
534 OpenSRF::AppRequest->new($self, $payload);
538 $msg->api_level($self->api_level);
539 $msg->payload($payload) if $payload;
541 my $locale = $self->session_locale;
542 $msg->sender_locale($locale) if ($locale);
544 $msg->sender_ingress($current_ingress);
549 $logger->debug(sub{return "AppSession sending ".$msg->type." to ".$self->remote_id.
550 " with threadTrace [".$msg->threadTrace."]" });
554 if ($self->endpoint == CLIENT and ! $disconnect) {
555 $self->queue_wait(0);
558 if($self->stateless && $self->state != CONNECTED) {
560 $logger->debug("AppSession is stateless in send", INTERNAL );
563 if( !$self->stateless and $self->state != CONNECTED ) {
565 $logger->debug( "Sending connect before request 1", INTERNAL );
567 unless (($self->state == CONNECTING && $connecting )) {
568 $logger->debug( "Sending connect before request 2", INTERNAL );
569 my $v = $self->connect();
571 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
574 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
581 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
582 $logger->internal("AppSession sending doc: $json");
584 $self->{peer_handle}->send(
585 to => $self->remote_id,
586 thread => $self->session_id,
590 $self->state( DISCONNECTED );
593 my $req = $self->app_request( $tT );
594 $req->{_start} = time;
602 return undef unless (defined $tT);
603 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
608 sub remove_app_request {
612 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
614 $self->{request_queue} = \@list;
618 return $_[0]->{endpoint};
624 return $self->{session_id};
630 my $req = $self->app_request($resp->[1]);
631 return $req->push_queue( $resp->[0] ) if ($req);
632 push @{ $self->{recv_queue} }, $resp->[0];
635 sub last_threadTrace {
637 my $new_last_threadTrace = shift;
639 my $old_last_threadTrace = $self->{last_threadTrace};
640 if (defined $new_last_threadTrace) {
641 $self->{last_threadTrace} = $new_last_threadTrace;
642 return $new_last_threadTrace unless ($old_last_threadTrace);
645 return $old_last_threadTrace;
648 sub session_threadTrace {
650 my $new_last_threadTrace = shift;
652 my $old_last_threadTrace = $self->{session_threadTrace};
653 if (defined $new_last_threadTrace) {
654 $self->{session_threadTrace} = $new_last_threadTrace;
655 return $new_last_threadTrace unless ($old_last_threadTrace);
658 return $old_last_threadTrace;
661 sub last_message_type {
663 my $new_last_message_type = shift;
665 my $old_last_message_type = $self->{last_message_type};
666 if (defined $new_last_message_type) {
667 $self->{last_message_type} = $new_last_message_type;
668 return $new_last_message_type unless ($old_last_message_type);
671 return $old_last_message_type;
674 sub last_message_api_level {
676 my $new_last_message_api_level = shift;
678 my $old_last_message_api_level = $self->{last_message_api_level};
679 if (defined $new_last_message_api_level) {
680 $self->{last_message_api_level} = $new_last_message_api_level;
681 return $new_last_message_api_level unless ($old_last_message_api_level);
684 return $old_last_message_api_level;
689 my $new_remote_id = shift;
691 my $old_remote_id = $self->{remote_id};
692 if (defined $new_remote_id) {
693 $self->{remote_id} = $new_remote_id;
694 return $new_remote_id unless ($old_remote_id);
697 return $old_remote_id;
705 my $old_ua = $self->{client_auth};
706 if (defined $new_ua) {
707 $self->{client_auth} = $new_ua;
708 return $new_ua unless ($old_ua);
711 return $old_ua->cloneNode(1);
716 my $new_state = shift;
718 my $old_state = $self->{state};
719 if (defined $new_state) {
720 $self->{state} = $new_state;
721 return $new_state unless ($old_state);
729 delete $$self{$_} for keys %$self;
739 if ( !(@proto_args % 2) ) {
741 } elsif (@proto_args == 1) {
742 %args = ( timeout => @proto_args );
746 #$logger->debug(sub{return ref($self). " recv_queue before wait: " . $self->_print_queue() }, INTERNAL );
748 if( exists( $args{timeout} ) ) {
749 $args{timeout} = int($args{timeout});
750 $self->{recv_timeout} = $args{timeout};
753 #$args{timeout} = 0 if ($self->complete);
755 if(defined($args{timeout})) {
756 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
759 my $avail = @{ $self->{recv_queue} };
760 $self->{remaining_recv_timeout} = $self->{recv_timeout};
764 $args{count} = $avail;
770 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
771 last if $self->complete;
772 my $starttime = time;
773 $self->queue_wait($self->{remaining_recv_timeout});
775 if ($self->{timeout_reset}) {
776 $self->{timeout_reset} = 0;
778 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
780 $avail = @{ $self->{recv_queue} };
783 $self->timed_out(1) if ( $self->{remaining_recv_timeout} <= 0 );
786 while ( my $msg = shift @{ $self->{recv_queue} } ) {
788 last if (scalar(@list) >= $args{count});
791 $logger->debug(sub{return "Number of matched responses: " . @list }, DEBUG );
792 $self->queue_wait(0); # check for statuses
794 return $list[0] if (!wantarray);
801 $self->{timed_out} = $out if (defined $out);
802 return $self->{timed_out};
807 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
812 $logger->debug(sub{return "Resending..." . @_RESEND_QUEUE }, INTERNAL );
813 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
814 $req->resend unless $req->complete;
821 if( ! $self->{peer_handle} ) { return 0; }
822 my $timeout = shift || 0;
823 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
824 my $o = $self->{peer_handle}->process($timeout);
832 foreach my $msg ( @{$self->{recv_queue}} ) {
833 $string = $string . $msg->toString(1) . "\n";
841 $self->send( 'STATUS', @_ );
844 sub reset_request_timeout {
847 my $req = $self->app_request($tt);
848 $req->{remaining_recv_timeout} = $req->{recv_timeout};
849 $req->{timout_reset} = 1;
852 #-------------------------------------------------------------------------------
854 package OpenSRF::AppRequest;
855 use base qw/OpenSRF::AppSession/;
856 use OpenSRF::Utils::Logger qw/:level/;
857 use OpenSRF::DomainObject::oilsResponse qw/:status/;
858 use Time::HiRes qw/time usleep/;
862 $class = ref($class) || $class;
865 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
868 my $self = { session => $session,
869 threadTrace => $threadTrace,
873 max_bundle_count => 0,
874 current_bundle_count=> 0,
876 max_bundle_size => 0,
877 current_bundle_size => 0,
878 current_bundle => [],
881 remaining_recv_timeout => 30,
883 part_recv_buffer=> '',
886 bless $self => $class;
888 push @{ $self->session->{request_queue} }, $self;
893 sub max_bundle_count {
896 $self->{max_bundle_count} = $value if (defined($value));
897 return $self->{max_bundle_count};
900 sub max_bundle_size {
903 $self->{max_bundle_size} = $value if (defined($value));
904 return $self->{max_bundle_size};
910 $self->{max_chunk_size} = $value if (defined($value));
911 return $self->{max_chunk_size};
917 if (defined $timeout) {
918 $self->{recv_timeout} = $timeout;
919 $self->{remaining_recv_timeout} = $timeout;
921 return $self->{recv_timeout};
925 my $size = @{$_[0]->{recv_queue}};
931 return unless ($self and $self->session and !$self->complete);
932 $self->session->send(@_);
937 return unless $self->session;
938 $self->session->remove_app_request($self);
939 delete($$self{$_}) for (keys %$self);
943 return shift()->{session};
948 my $complete = shift;
949 return $self->{complete} if ($self->{complete});
950 if (defined $complete) {
951 $self->{complete} = $complete;
952 $self->{_duration} = time - $self->{_start} if ($self->{complete});
954 $self->session->queue_wait(0);
956 $self->completing(0) if ($self->{complete});
957 return $self->{complete};
963 $self->{_completing} = $value if (defined($value));
964 return $self->{_completing};
969 $self->wait_complete;
970 return $self->{_duration};
975 my $timeout = shift || 10;
976 my $time_remaining = $timeout;
978 while ( ! $self->complete and $time_remaining > 0 ) {
979 my $starttime = time;
980 $self->queue_wait($time_remaining);
982 $time_remaining -= ($endtime - $starttime);
985 return $self->complete;
989 return shift()->{threadTrace};
995 if( !$resp ) { return 0; }
996 if( UNIVERSAL::isa($resp, "Error")) {
997 $self->{failed} = $resp;
999 #return; eventually...
1002 if( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::Partial")) {
1003 $self->{part_recv_buffer} .= $resp->content;
1005 } elsif( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::PartialComplete")) {
1006 if ($self->{part_recv_buffer}) {
1007 $resp = new OpenSRF::DomainObject::oilsResult;
1008 $resp->content( OpenSRF::Utils::JSON->JSON2perl( $self->{part_recv_buffer} ) );
1009 $self->{part_recv_buffer} = '';
1013 push @{ $self->{recv_queue} }, $resp;
1018 return $self->{failed};
1023 return $self->session->queue_wait(@_)
1026 sub payload { return shift()->{payload}; }
1030 return unless ($self and $self->session and !$self->complete);
1031 OpenSRF::Utils::Logger->debug(sub{return "I'm resending the request for threadTrace ". $self->threadTrace }, DEBUG);
1032 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
1038 return unless ($self and $self->session and !$self->complete);
1039 $self->session->send( 'STATUS',$msg, $self->threadTrace );
1042 # TODO stream_push only works when server sessions can accept RESULT
1043 # messages, which is no longer supported. Create a new OpenSRF message
1044 # type to support client-to-server streams.
1048 # $self->respond( $msg );
1054 return unless ($self and $self->session and !$self->complete);
1056 my $type = 'RESULT';
1058 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResponse')) {
1060 $type = 'STATUS' if UNIVERSAL::isa($response, 'OpenSRF::DomainObject::oilsStatus');
1064 if ($self->max_chunk_size > 0) { # we might need to chunk
1065 my $str = OpenSRF::Utils::JSON->perl2JSON($msg);
1067 # XML can add a lot of length to a chunk due to escaping, so we
1068 # calculate chunk size based on an XML-escaped version of the message.
1069 # Example: If escaping doubles the length of the string then $ratio
1070 # will be 0.5 and we'll cut the chunk size for this message in half.
1072 my $raw_length = length(Encode::encode_utf8($str)); # count bytes
1073 my $escaped_length = $raw_length;
1074 $escaped_length += 11 * (() = ( $str =~ /"/g)); # 7 \s and "
1075 $escaped_length += 4 * (() = ( $str =~ /&/g)); # &
1076 $escaped_length += 3 * (() = ( $str =~ /[<>]/g)); # < / >
1078 my $chunk_size = $self->max_chunk_size;
1080 if ($escaped_length > $self->max_chunk_size) {
1081 $chunk_size = POSIX::floor(($raw_length / $escaped_length) * $self->max_chunk_size);
1084 if ($raw_length > $chunk_size) { # send partials ("chunking")
1085 # First, send out any messages queued up to be sent as
1086 # a bundle; otherwise, the chunked message will get sent
1088 if ($self->{current_bundle_count} > 0) {
1089 # ignore any errors; if there's a problem, it presumably
1090 # will be reported when the partial-complete message
1092 $self->session->send( @{$self->{current_bundle}}, $self->threadTrace);
1093 $self->{current_bundle} = [];
1094 $self->{current_bundle_size} = 0;
1095 $self->{current_bundle_count} = 0;
1097 my $num_bytes = length(Encode::encode_utf8($str));
1098 for (my $i = 0; $i < $num_bytes; $i += $chunk_size) {
1099 $response = new OpenSRF::DomainObject::oilsResult::Partial;
1100 $response->content( substr($str, $i, $chunk_size) );
1101 $self->session->send($type, $response, $self->threadTrace);
1103 # This triggers reconstruction on the remote end
1104 $response = new OpenSRF::DomainObject::oilsResult::PartialComplete;
1105 return $self->session->send($type, $response, $self->threadTrace);
1109 # message failed to exceed max chunk size OR chunking disabled
1110 $response = new OpenSRF::DomainObject::oilsResult;
1111 $response->content($msg);
1114 if ($self->{max_bundle_count} > 0 or $self->{max_bundle_size} > 0) { # we are bundling, and we need to test the size or count
1116 $self->{current_bundle_size} += length(
1117 Encode::encode_utf8(OpenSRF::Utils::JSON->perl2JSON($response)));
1118 push @{$self->{current_bundle}}, $type, $response;
1119 $self->{current_bundle_count}++;
1121 if ( $self->completing ||
1122 ($self->{max_bundle_size} && $self->{current_bundle_size} >= $self->{max_bundle_size} ) ||
1123 ($self->{max_bundle_count} && $self->{current_bundle_count} >= $self->{max_bundle_count})
1124 ) { # send chunk and reset
1125 my $send_res = $self->session->send( @{$self->{current_bundle}}, $self->threadTrace);
1126 $self->{current_bundle} = [];
1127 $self->{current_bundle_size} = 0;
1128 $self->{current_bundle_count} = 0;
1130 } else { # not at a chunk yet, just queue it up
1131 return $self->session->app_request( $self->threadTrace );
1135 $self->session->send($type, $response, $self->threadTrace);
1138 sub respond_complete {
1141 return unless ($self and $self->session and !$self->complete);
1143 $self->respond($msg) if (defined($msg));
1145 $self->completing(1);
1147 OpenSRF::DomainObject::oilsConnectStatus->new(
1148 statusCode => STATUS_COMPLETE(),
1149 status => 'Request Complete'
1155 sub register_death_callback {
1158 $self->session->register_callback( death => $cb );
1162 # utility method. checks to see of the request failed.
1163 # if so, throws an OpenSRF::EX::ERROR. if everything is
1164 # ok, it returns the content of the request
1168 $self->wait_complete;
1169 my $resp = $self->recv( timeout => 60 );
1170 if( $self->failed() ) {
1171 throw OpenSRF::EX::ERROR
1172 ($self->failed()->stringify());
1174 if(!$resp) { return undef; }
1175 my $content = $resp->content;
1176 if($finish) { $self->finish();}
1181 package OpenSRF::AppSubrequest;
1182 use base 'OpenSRF::AppRequest';
1186 return if $self->complete;
1189 return $self->SUPER::respond($resp) if $self->respond_directly;
1191 push @{$$self{resp}}, $resp if (defined $resp);
1194 sub respond_complete {
1196 return $self->SUPER::respond_complete(@_) if $self->respond_directly;
1203 $class = ref($class) || $class;
1206 respond_directly=> 0, # use the passed session directly (RD mode)
1208 threadTrace => 0, # needed for respond in RD mode
1209 max_chunk_count => 0, # needed for respond in RD mode
1210 max_chunk_size => 0, # needed for respond in RD mode
1211 max_bundle_size => 0,
1212 current_bundle => [], # needed for respond_complete in RD mode
1213 current_bundle_count=> 0,
1214 current_bundle_size => 0,
1215 max_bundle_count => 0,
1218 if ($self->session) {
1219 # steal the thread trace from the parent session for RD mode
1220 $self->{threadTrace} = $self->session->session_threadTrace || $self->session->last_threadTrace;
1225 sub responses { @{$_[0]->{resp}} }
1227 sub respond_directly {
1230 $x->{respond_directly} = $s if (defined $s);
1231 return $x->session && $x->{respond_directly};
1237 $x->{session} = $s if ($s);
1238 return $x->{session};
1244 $x->{complete} = $c if ($c);
1245 $x->completing(0) if ($c);
1246 return $x->{complete};
1252 $self->{_completing} = $value if (defined($value));
1253 return $self->{_completing};