Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeSafonov committed Mar 17, 2020
1 parent 4b3c0e8 commit 5f414b0
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ The following tables show the available configuration:
| `smpp.defaults.rebindPeriod` | Connection rebind period (Duration) | `90s` |
| `smpp.defaults.requestTimeout` | Request timeout (Duration) | `5s` |
| `smpp.defaults.allowedPhones` | Array of phones to send. Using only if `connectionMode` is `TEST` | `[]` |
| `smpp.defaults.connectionType` | Type of smpp connections(`TRANSCEIVER` or `TRANSMITTER_RECEIVER`) | `TRANSMITTER_RECEIVER` |
| `smpp.connections` | Map of SMSC connections | |
| `smpp.connections.<name>.credentials` | SMSC connection credentials | |
| `smpp.connections.<name>.credentials.host` | SMSC host | |
Expand All @@ -95,6 +96,7 @@ The following tables show the available configuration:
| `smpp.connections.<name>.rebindPeriod` | Connection rebind period (Duration) | `90s` |
| `smpp.connections.<name>.requestTimeout` | Request timeout (Duration) | `5s` |
| `smpp.connections.<name>.allowedPhones` | Array of phones to send. Using only if `connectionMode` is `TEST` | `[]` |
| `smpp.connections.<name>.connectionType` | Type of smpp connections(`TRANSCEIVER` or `TRANSMITTER_RECEIVER`) | |
| `smpp.setupRightAway` | Should setup smpp clients after creation and fail fast if connection cant be established | `true` |

Configuration example for `.properties` file:
Expand Down Expand Up @@ -166,7 +168,8 @@ This starter provide several abstractions:

### SenderClient

This interface represents smpp protocol _TRANSMITTER_ client. This is entry point to sending any messages.
This interface represents smpp protocol _TRANSMITTER_ or _TRANSCEIVER_ (see `connectionType` property) client.
This is entry point to sending any messages.
Spring-boot-starter-smpp comes with several implementations:

![class diagram](http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/MikeSafonov/spring-boot-starter-smpp/master/diagrams/senderclient_class.txt)
Expand Down Expand Up @@ -208,7 +211,8 @@ Starter provide **DefaultTypeOfAddressParser** and **UnknownTypeOfAddressParser*

### ResponseClient

This abstraction represent connection via SMPP with _RECEIVER_ type. Key purpose is listening delivery receipts.
This abstraction represent connection via SMPP with _RECEIVER_ or _TRANSCEIVER_ (see `connectionType` property) type.
Key purpose is listening delivery receipts.
`By default` starter use **DefaultResponseClient**. This class keeping smpp connection and pushing delivery receipts to [DeliveryReportConsumer](#DeliveryReportConsumer).

### DeliveryReportConsumer
Expand Down

0 comments on commit 5f414b0

Please sign in to comment.