Author: mgoulish
Date: Fri May 10 07:53:03 2013
New Revision: 1480905
URL: http://svn.apache.org/r1480905
Log:
PROTON-260 : Style changes to code parentheses, section headers, and emphasis
designators.
Modified:
qpid/proton/trunk/docs/markdown/messenger/addressing-and-routing.md
qpid/proton/trunk/docs/markdown/messenger/message-disposition.md
qpid/proton/trunk/docs/markdown/messenger/sending-and-receiving.md
Modified: qpid/proton/trunk/docs/markdown/messenger/addressing-and-routing.md
URL:
http://svn.apache.org/viewvc/qpid/proton/trunk/docs/markdown/messenger/addressing-and-routing.md?rev=1480905&r1=1480904&r2=1480905&view=diff
==============================================================================
--- qpid/proton/trunk/docs/markdown/messenger/addressing-and-routing.md
(original)
+++ qpid/proton/trunk/docs/markdown/messenger/addressing-and-routing.md Fri May
10 07:53:03 2013
@@ -64,11 +64,11 @@ Routing
The Messenger library provides message routing capability
with an address translation table. Each entry in the table
-consists of a _pattern_ and a _translation_.
+consists of a *pattern* and a *translation*.
You store a new route entry in the table with the call:
- pn_messenger_route ( messenger, pattern, translation );
+ pn_messenger_route(messenger, pattern, translation);
The address of each outgoing message is compared to the
Modified: qpid/proton/trunk/docs/markdown/messenger/message-disposition.md
URL:
http://svn.apache.org/viewvc/qpid/proton/trunk/docs/markdown/messenger/message-disposition.md?rev=1480905&r1=1480904&r2=1480905&view=diff
==============================================================================
--- qpid/proton/trunk/docs/markdown/messenger/message-disposition.md (original)
+++ qpid/proton/trunk/docs/markdown/messenger/message-disposition.md Fri May 10
07:53:03 2013
@@ -34,16 +34,16 @@ direction works similarly. )
When you call
- pn_messenger_set_incoming_window ( messenger, window_size );
+ pn_messenger_set_incoming_window(messenger, window_size);
you have only declared the window size. The window is not yet
created. The window will be created when you issue your first
call to
- pn_messenger_get ( messenger, msg );
+ pn_messenger_get(messenger, msg);
And the window will be further populated only by further calls to
-pn_messenger_get ( ).
+pn_messenger_get().
@@ -51,12 +51,12 @@ pn_messenger_get ( ).
-### receiving ###
+### Receiving ###
To explicitly set or get message dispositions, your messenger
must set a positive size for its incoming window:
- pn_messenger_set_incoming_window ( messenger, N );
+ pn_messenger_set_incoming_window(messenger, N);
You can implicity accept messages by simply letting enough
new messages arrive. As older messages pass beyond the threshold
@@ -65,26 +65,26 @@ accepted. Thus, if you want to automati
messages as they arrive, you can set your incoming window
size to 0.
-To exercise _explicit_ control over particular messages or ranges
+To exercise *explicit* control over particular messages or ranges
of messages, the receiver can use trackers. The call
- pn_messenger_incoming_tracker ( messenger );
+ pn_messenger_incoming_tracker(messenger);
will return a tracker for the message most recently returned
by a call to
- pn_messenger_get ( messenger, message );
+ pn_messenger_get(messenger, message);
With a message that is being tracked, the messenger can accept
(or reject) that individual message:
- pn_messenger_accept ( messenger, tracker, 0 );
- pn_messenger_reject ( messenger, tracker, 0 );
+ pn_messenger_accept(messenger, tracker, 0);
+ pn_messenger_reject(messenger, tracker, 0);
Or it can accept (or reject) the tracked message as well as all older
messages back to the limit of the incoming window:
- pn_messenger_accept ( messenger, tracker, PN_CUMULATIVE );
- pn_messenger_reject ( messenger, tracker, PN_CUMULATIVE );
+ pn_messenger_accept(messenger, tracker, PN_CUMULATIVE);
+ pn_messenger_reject(messenger, tracker, PN_CUMULATIVE);
Once a message is accepted or rejected, its status can no longer
be changed, even if you have a separate tracker associated with it.
@@ -93,10 +93,10 @@ be changed, even if you have a separate
<br/>
-###when to accept###
+###When to Accept###
-Although you _can_ accept messages implicitly by letting them fall
-off the edge of your incoming window, you _shouldn't_. Message
+Although you *can* accept messages implicitly by letting them fall
+off the edge of your incoming window, you *shouldn't*. Message
disposition is an important form of communication to the sender.
The best practice is to let the sender know your response, by
explicit acceptance or rejection, as soon as you can. Implicitly
@@ -109,7 +109,7 @@ how much state your Messenger needs to t
<br/>
-###accepting by accident####
+###Accepting by Accident####
If you allow a message to "fall off the edge" of your incoming
window before you have explicitly accepted or rejected it, then
@@ -117,7 +117,7 @@ it will be accepted automatically.
But since your incoming window is only filled by calls to
- pn_messenger_get ( messenger, msg );
+ pn_messenger_get(messenger, msg);
messages cannot be forced to fall over the edge by simply
receiving more messages. Messages will not be forced over the
@@ -136,25 +136,25 @@ as practical after getting and processin
-### sending ###
+### Sending ###
A sender can learn how an individual message has been received
if it has a positive outgoing window size:
- pn_messenger_set_outgoing_window ( messenger, N );
+ pn_messenger_set_outgoing_window(messenger, N);
and if a tracker has been associated with that message in question.
This call:
- pn_messenger_outgoing_tracker ( messenger );
+ pn_messenger_outgoing_tracker(messenger);
will return a tracker for the message most recently given to:
- pn_messenger_put ( messenger, message );
+ pn_messenger_put(messenger, message);
To later find the status of the individual tracked message, you can call:
- pn_messenger_status ( messenger, tracker );
+ pn_messenger_status(messenger, tracker);
The returned value will be one of
@@ -166,8 +166,8 @@ The returned value will be one of
If either the sender or the receiver simply declares the message (or range of
messages) to
be settled, with one of these calls:
- pn_messenger_settle ( messenger, tracker, 0 );
- pn_messenger_settle ( messenger, tracker, PN_CUMULATIVE );
+ pn_messenger_settle(messenger, tracker, 0);
+ pn_messenger_settle(messenger, tracker, PN_CUMULATIVE);
then the sender will see `PN_STATUS_PENDING` as the status of any
settled messages.
@@ -175,19 +175,19 @@ settled messages.
<br/>
-### message rejection ###
+### Message Rejection ###
If a message is rejected by the receiver, it does not mean that
the message was malformed. Malformed messages cannot be sent.
Even messages with no content are valid messages.
Rejection by a receiver should be understood as the receiver
-saying "I don't want this." or possibly "I don't want this _yet_."
+saying "I don't want this." or possibly "I don't want this *yet*."
depending on your application.
The sender could decide to try sending the same message again later,
or to send the message to another receiver, or to discard it.
The AMQP 1.0 specification permits a distinction
-between _rejecting_ the message, and _releasing_ the message,
-but the Proton library does not expose the _releasing_
+between *rejecting* the message, and *releasing* the message,
+but the Proton library does not expose the *releasing*
disposition.
Modified: qpid/proton/trunk/docs/markdown/messenger/sending-and-receiving.md
URL:
http://svn.apache.org/viewvc/qpid/proton/trunk/docs/markdown/messenger/sending-and-receiving.md?rev=1480905&r1=1480904&r2=1480905&view=diff
==============================================================================
--- qpid/proton/trunk/docs/markdown/messenger/sending-and-receiving.md
(original)
+++ qpid/proton/trunk/docs/markdown/messenger/sending-and-receiving.md Fri May
10 07:53:03 2013
@@ -26,7 +26,7 @@ When receiving messages, you can:
Functions
------------------------------
-* `pn_messenger_put ( messenger )`
+* `pn_messenger_put(messenger)`
Stage message for later transmission, and possibly
transmit any messages currently staged that are not
@@ -35,9 +35,9 @@ Functions
-* `pn_messenger_send ( messenger )`
+* `pn_messenger_send(messenger)`
- If messenger timeout is negative (initial default ),
+ If messenger timeout is negative (initial default),
block until all staged messages have been sent.
If messenger timeout is 0, send all messages that
@@ -46,13 +46,13 @@ Functions
If messenger timeout is positive, send all messages
that can be sent until timeout expires.
- _note: If there are any messages that can be received
+ *note: If there are any messages that can be received
when `pn_messenger_send()` is called, they will
- be received._
+ be received.*
-* `pn_messenger_get ( messenger, msg )`
+* `pn_messenger_get(messenger, msg)`
Dequeue the head of the incoming message queue to
your application.
@@ -60,9 +60,9 @@ Functions
-* `pn_messenger_recv ( messenger )`
+* `pn_messenger_recv(messenger)`
- If messenger timeout is negative ( initial default ),
+ If messenger timeout is negative(initial default),
block until at least one message is received.
If timeout is 0, receive whatever messages are available,
@@ -71,8 +71,8 @@ Functions
If timeout is positive, receive available messages until
timeout expires.
- _note: If there are any unblocked outgoing messages,
- they will be sent during this call._
+ *note: If there are any unblocked outgoing messages,
+ they will be sent during this call.*
@@ -83,62 +83,62 @@ Examples
* send a message immediately
- pn_messenger_put ( messenger, msg );
- pn_messenger_send ( messenger );
+ pn_messenger_put(messenger, msg);
+ pn_messenger_send(messenger);
* enqueue a message to be sent later
- pn_messenger_put ( messenger, msg );
+ pn_messenger_put(messenger, msg);
- _note:
+ *note:
The message will be sent whenever it is not blocked and
- the Messenger code has other I/O work to be done._
+ the Messenger code has other I/O work to be done.*
* block until all enqueued messages are sent
- pn_messenger_set_timeout ( messenger, -1 );
- pn_messenger_send ( messenger );
+ pn_messenger_set_timeout(messenger, -1);
+ pn_messenger_send(messenger);
- _note:
+ *note:
A negative timeout means 'forever'. That is the initial
- default for a messenger._
+ default for a messenger.*
* send enqueued messages until a timeout occurs
- pn_messenger_set_timeout ( messenger, 100 ); /* 100 msec */
- pn_messenger_send ( messenger );
+ pn_messenger_set_timeout(messenger, 100); /* 100 msec */
+ pn_messenger_send(messenger);
* send all messages that can be sent without blocking
- pn_messenger_set_timeout ( messenger, 0 );
- pn_messenger_send ( messenger );
+ pn_messenger_set_timeout(messenger, 0);
+ pn_messenger_send(messenger);
* receive messages that can be received without blocking
- pn_messenger_set_timeout ( messenger, 0 );
- pn_messenger_recv ( messenger, -1 );
+ pn_messenger_set_timeout(messenger, 0);
+ pn_messenger_recv(messenger, -1);
* block until at least one message is received
- pn_messenger_set_timeout ( messenger, -1 );
- pn_messenger_recv ( messenger, -1 );
+ pn_messenger_set_timeout(messenger, -1);
+ pn_messenger_recv(messenger, -1);
- _note: -1 is initial messenger default._
+ *note: -1 is initial messenger default.*
* receive no more than a fixed number of messages
- pn_messenger_recv ( messenger, 10 );
+ pn_messenger_recv(messenger, 10);
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
