From 5f414b0534a921d2c0101ff936cb71490e65f1d7 Mon Sep 17 00:00:00 2001 From: msafonov Date: Tue, 17 Mar 2020 10:34:52 +0300 Subject: [PATCH] docs: update README --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5365e2..924f8c0 100644 --- a/README.md +++ b/README.md @@ -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..credentials` | SMSC connection credentials | | | `smpp.connections..credentials.host` | SMSC host | | @@ -95,6 +96,7 @@ The following tables show the available configuration: | `smpp.connections..rebindPeriod` | Connection rebind period (Duration) | `90s` | | `smpp.connections..requestTimeout` | Request timeout (Duration) | `5s` | | `smpp.connections..allowedPhones` | Array of phones to send. Using only if `connectionMode` is `TEST` | `[]` | +| `smpp.connections..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: @@ -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) @@ -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