Skip to content

Commit 8ed68df

Browse files
committed
[skip ci] another language improvement
1 parent 9d3b390 commit 8ed68df

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

doc/modules/mod_jingle_sip.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When this module is enabled, MongooseIM will intercept any Jingle IQ set stanza
1010

1111
and translate it to SIP messages with appropriate SDP content based on the details in the Jingle stanza.
1212

13-
The translation back from SIP to Jingle is done for following SIP requests:
13+
The translation back from SIP to Jingle is done for the following SIP requests:
1414

1515
* `INVITE`
1616
* `re-INVITE` - `INVITE` message sent for an accepted session
@@ -27,7 +27,7 @@ and following responses to the INVITE request:
2727

2828
#### Jingle to SIP translation
2929

30-
The table below summarises the translation both ways for standard Jingle and SIP messages:
30+
The table below summarises the bilateral translation for standard Jingle and SIP messages:
3131

3232
| Jingle action | SIP message | comment |
3333
| ------------- | ----------- | ------- |
@@ -40,22 +40,23 @@ The table below summarises the translation both ways for standard Jingle and SIP
4040

4141
##### Ringing notification
4242

43-
Both Jingle and SIP has the `ringing` notification.
43+
Both Jingle and SIP have the `ringing` notification.
4444
It's generated as a response code `180 Ringing` by a SIP entity when the INVITE is sent to the device.
45-
In SIP world there is also `183 Session Progress` response code generated in some cases.
46-
Both the codes `180` and `183` are translated as `session-info` Jingle stanza with `ringing` sub element.
45+
In SIP world a `183 Session Progress` response code is also generated in some cases.
46+
Both `180` and `183` codes are translated as `session-info` Jingle stanza with `ringing` sub element.
4747
MongooseIM generates only `180 Ringing` response code the `INVITE` request, if the recipient's online.
48+
If the recipient is online, MongooseIM generates the `180 Ringing` response code to the `INVITE` request.
4849

4950
##### Recipient unavailable
5051

51-
When MongooseIM receives and SIP `INVITE` request to a user who is offline,
52-
it will reply with `480 Temporarily Unavailable` code.
52+
When MongooseIM receives a SIP `INVITE` request addressed to an offline user,
53+
it replies with a `480 Temporarily Unavailable` code.
5354
The same code is expected from the SIP Proxy when MongooseIM sends the `INVITE` request.
5455

5556
##### Other error codes
5657

57-
When MongooseIM receives any error code to the INVITE request from range `400` to `699` but other then `486`,
58-
it will send Jingle `session-terminate` stanza to the call's initiator.
58+
When an error response to the `INVITE` request is from the range `400` to `699` but not `486`,
59+
MongooseIM will send a Jingle `session-terminate` stanza to the call's initiator.
5960
The stanza has reason `general-error` with the SIP error code in the `sip-error` sub element.
6061

6162
##### Non-standard Jingle stanzas used by jingle.js
@@ -66,12 +67,12 @@ The following non-standard Jingle stanzas were integrated with https://github.co
6667
* `source-add`
6768
* `source-update`
6869

69-
When MongooseIM observes the above Jingle stanzas it will translate them to a SIP in-dialog INVITE request.
70+
When MongooseIM observes the above Jingle stanzas, it will translate them to a SIP in-dialog `INVITE` request.
7071
In the SDP content of the request, there will be a custom attribute `a=jingle-action`.
7172
The value of the custom attribute is one of the three presented above.
7273

73-
Similarly when MongooseIM gets SIP in-dialog `INVITE` request it will check if there is the custom attribute
74-
and use as the `action` attribute of the Jingle stanza sent to the user.
74+
Similarly when MongooseIM gets a SIP in-dialog `INVITE` request,
75+
it will check if there is a custom attribute and use it as the `action` attribute of the Jingle stanza sent to the user.
7576
If there is no such attribute, the action will be set to regular Jingle `transport-info`.
7677

7778
##### Non-stadard Jingle existing-session-initiate stanza
@@ -80,7 +81,7 @@ MongooseIM allows a user to ask for an unanswered `session-initiate` request.
8081
This may be useful in web applications when there is a need to handle the call in a new browser window.
8182

8283
In order to get the `session-initiate`, which was not answered yet, the user can send a `get` Jingle stanza to self with action set to `existing-session-initiate`.
83-
In result, MongooseIM will resent the original `session-initiate` request to the device which sent the query.
84+
As a result, MongooseIM will resend the original `session-initiate` request to the device which sent the query.
8485

8586

8687
### Prerequisites
@@ -123,10 +124,10 @@ All the sequence diagrams where generated with [textart.io/sequence](https://tex
123124
The source code is embedded in the markdown file below every diagram inside a comment `<!--- --->`
124125

125126

126-
#### 1. Establishing a session with other XMPP user
127+
#### 1. Establishing a session with another XMPP user
127128

128129
With the mod_jingle_sip enabled, all Jingle IQ set stanzas listed above are intercepted, translated to SIP packets and sent to a SIP Proxy.
129-
This means that current implementation will also translate stanzas addressed to a user in the same domain.
130+
This means that the current implementation will also translate stanzas addressed to a user in the same domain.
130131
This allows the SIP entity to control how the call between XMPP users is established.
131132
Below there are sequence diagrams showing the communication between XMPP users, MongooseIM and SIP Proxy as in our tests.
132133
It's possible that the SIP Proxy or other SIP entity decides that the call needs to be forked
@@ -247,7 +248,7 @@ See the following examples for more information.
247248
###### 1.3.1 Terminating an accepted call
248249

249250
The easiest scenario is when the call was accepted as in [1.2](#12-signaling-session-accept-to-other-xmpp-user-via-sip-proxy).
250-
In this case one of the users sends a `session-terminate` Jingle action with reason `success`.
251+
In this case one of the users sends a `session-terminate` Jingle action with a reason `success`.
251252
This is translated to a SIP `BYE` request with `to` and `from` headers set appropriately -
252253
`from` is the user who wants to terminate the call and `to` is the user on the other end of the session.
253254
The `BYE` request is sent to the SIP Proxy and then to the other user in a similar way to session acceptance.
@@ -266,6 +267,6 @@ MongooseIM translates this to SIP `486 Busy Here` **Response** (because this is
266267

267268
Establishing a session with a SIP user (or a SIP entity) works the same as in the previous section.
268269
The only difference is that the SIP Proxy will not call MongooseIM back (as it may happen for call to other XMPP user).
269-
Instead the SIP message send by MongooseIM to SIP Proxy will be delivered directly to the SIP user's device.
270+
Instead the SIP message sent by MongooseIM to SIP Proxy will be delivered directly to the SIP user's device.
270271

271272

0 commit comments

Comments
 (0)