Changes between Version 20 and Version 21 of Infinote/Protocol

Timestamp:

12/06/09 23:51:10 (3 years ago)

Author:

armin (IP: 89.247.172.45)

Comment:

Note about enhanced child text

Infinote/Protocol

@@ -62 +62 @@
  * more to follow (peer-to-peer, groupchat, ...)
 
+=== Enhanced Child Text ===
+
+Some XML nodes allow child text which contains <uchar codepoint="uuuu" /> children, with uuuu being a unicode character point in decimal notation. This is to be interpreted as if the child text contained the given unicode character at the position of the <uchar /> node. This allows transmission of characters that would otherwise be invalid XML, such as null bytes. Below is explicitely stated whether a message allows such ''enhanced'' child text or not.
+
 == Directory messages ==
 
@@ -160 +164 @@
  * code, Integer: A numerical error code identifying what went wrong. The meaning depends on the error domain.
  * seq, Integer: The seq_id the client had set in the original request that failed, if any.
- * text, optional: Human-readable error message in the server's language.
+ * text, optional: Human-readable error message in the server's language. Does not allow enhanced child text.
  * Scope: point-to-point
 
@@ -364 +368 @@
  * domain, String: A domain from which the error comes. This is most likely "INF_SESSION_SYNCHRONIZATION_ERROR".
  * code, Integer: A numerical error code explaining what went wrong, depending on domain.
- * text, String, optional: A human-readable error message, in the synchronization client's language.
+ * text, String, optional: A human-readable error message, in the synchronization client's language. Does not allow enhanced child text.
  * Scope: point-to-point
 
@@ -464 +468 @@
  * code, Integer: A numerical error ID specifying what went wrong, depending on domain.
  * seq, Integer: The seq that the client set for the original request that failed, if any.
- * text, String, optional: Human-readable error message in the server's language.
+ * text, String, optional: Human-readable error message in the server's language. Does not allow enhanced child text.
  * Scope: point-to-point
 
@@ -532 +536 @@
  * user, Integer: The user that has sent the message.
  * time, Integer: A Unix timestamp (number of seconds since 01/01/1970 00:00 UTC) of when the message was sent.
- * Text, Optional: The text of the message. Messages of type "userjoin" and "userpart" don't have text.
+ * Text, Optional: The text of the message. Messages of type "userjoin" and "userpart" don't have text. Does not allow enhanced child text.
 
 This synchronizes a message that was sent earlier to a client. It provides the client with a history of earlier chat messages.
@@ -548 +552 @@
  * type, Optional: Type of the message. Can be "normal" or "emote". If it is omitted, then it defaults to normal.
  * user, Integer: User ID of the user sending the message. The user must have joined via the connection the message comes from. 
+ * Text: The text of the message. Does not allow enhanced child text.
 
 Sent when a user sends a message to the chat.
@@ -602 +607 @@
 
  * pos, Integer: The character offset at which to start deleting characters.
- * segments: The text that was deleted, including author information, i.e. which user wrote what text.
+ * segments: The text that was deleted, including author information, i.e. which user wrote what text. Does allow enhanced child text.
 
 Deletes text from the buffer and specifies what text is deleted. This operation is only used in <sync-request /> messages. The synchronization client cannot deduce what text was actually deleted, but must be able to compute the reverse operation in case someone undoes the request. In a normal <request /> message, other users can deduce what text was deleted by having a look at the document and which transformations were required to transform the request to the current state before the operation is actually executed.
@@ -668 +673 @@
 
  * author, optional: The user ID of the user that wrote the text.
- * Text: The text that user wrote.
+ * Text: The text that user wrote. Does allow enhanced child text.
  * Scope: point-to-point