Added some pod for type_key, serializer and subscribe_header features
Jason Tang [Wed, 5 Aug 2009 10:34:00 +0000 (11:34 +0100)]
lib/Catalyst/Controller/MessageDriven.pm
lib/Catalyst/Engine/Stomp.pm

index c101df8..100d3f6 100644 (file)
@@ -47,6 +47,25 @@ Dispatches to method named by the key C<< $c->stash->{request}->{type} >>
 
 Serializes the response from C<< $c->stash->{response} >>
 
+=head1 CONFIGURATION
+
+In the configuration file add the following to set the value for a parameter
+
+  <MessageDriven>
+    type_key foo
+  </MessageDriven>
+
+=head2 type_key
+
+The hash key the module will try to pull out the received message to call
+within the controller. This defaults to 'type'.
+
+=head2 serializer
+
+The serializer used to serialiser/deserialise. See Data::Serializer to see
+what is available. Defaults to YAML. JSON is anotther that is available.
+
+
 =cut
 
 class_type 'Data::Serializer';
index f2b588f..e437361 100644 (file)
@@ -27,8 +27,11 @@ Catalyst::Engine::Stomp - write message handling apps with Catalyst.
 
   MyApp->config->{Engine::Stomp} =
    {
-     hostname => '127.0.0.1',
-     port     => 61613,
+     hostname         => '127.0.0.1',
+     port             => 61613,
+     subscribe_header => {
+       transformation       => 'jms-to-json',
+     }
    };
   MyApp->run();
 
@@ -197,7 +200,6 @@ sub handle_stomp_message {
     # ack the message off the queue now we've replied / processed
     $self->connection->ack( { frame => $frame } );
 }
-
 =head2 handle_stomp_error
 
 Log any Stomp error frames we receive.
@@ -213,3 +215,11 @@ sub handle_stomp_error {
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 CONFIGURATION
+
+=head2 subscribe_header
+
+Add additional header key/value pairs to the subscribe message sent to the
+message broker.
+
+=cut