DSoftBus

## Restrictions

- Connections can only be established between devices within the same local area network (LAN) or between nearby device ranges.
- Before establishing a connection between two devices, you must bind the devices. For more information, see [Security](https://gitee.com/openharmony/docs/blob/master/en/readme/Security.md).
- After completing data transmission, the service should close the session to free up resources.

## Usage

> **NOTE**
>
> Remote procedure calls (RPCs) between devices require permissions `ohos.permission.DISTRIBUTED_DATASYNC` and `ohos.permission.DISTRIBUTED_SOFTBUS_CENTER`.
```### Обнаружение устройств

- **Процесс публикации**

1. Вызовите **PublishLNN()**, чтобы опубликовать информацию об приложении через сеть.

    ```C
    // Коллбэк для возврата результата публикации.
    typedef struct {
        /** Коллбэк для результата публикации */
        void (*OnPublishResult)(int publishId, PublishResult reason);
    } IPublishCb;

    // Информация для публикации.
    typedef struct {
        int publishId;                 // ID публикации.
        DiscoverMode mode;             // Режим обнаружения.
        ExchangeMedium medium;         // Средство связи.
        ExchangeFreq freq;             // Частота использования.
        const char *capability;        // Возможности устройства для обнаружения.
        unsigned char *capabilityData; // Дополнительные данные для публикации.
        unsigned int dataLen;          // Длина данных.
        bool ranging;                  // Нужно ли использовать дальность.
    } PublishInfo;
    
    // Опубликовать информацию.
    int32_t PublishLNN(const char *pkgName, const PublishInfo *info, const IPublishCb *cb);
    ```

2. Вызовите **StopPublishLNN**, чтобы прекратить публикацию информации, когда она больше не требуется.

    ```C
    // Прекратить публикацию услуги.
    int32_t StopPublishLNN(const char *pkgName, int32_t publishId);
    ```

- **Процесс обнаружения**

1. Вызовите **RefreshLNN()**, чтобы обнаружить устройства с указанными возможностями.```C
// Callbacks for device discovery.
typedef struct {
    /** Callback to invoke when a device is discovered. */
    void (*OnDeviceFound)(const DeviceInfo *device);
    /** Callback for subscription result. */
    void (*OnDiscoverResult)(int32_t refreshId, RefreshResult reason);
} IRefreshCallback;

// Start device discovery.
int32_t RefreshLNN(const char *pkgName, const SubscribeInfo *info, const IRefreshCallback *cb);

```C
// Остановка поиска.
int32_t StopRefreshLNN(const char *pkg_name, int32_t refresh_id);
```

1. Создайте экземпляр **Socket**.

    ```C
    typedef struct {
        char *name;                 // Локальное имя сокета.
        char *peerName;             // Имя соединяемого сокета.
        char *peerNetworkId;        // Network ID соединяемого устройства.
        char *pkgName;              // Имя пакета вызывающего модуля.
        TransDataType dataType;     // Тип передаваемых данных.
    } SocketInfo;

    // Создание сокета.
    int32_t Socket(SocketInfo info);
    ```

2. Начните прослушивание сокета на сервере и привязывайте сокет на клиенте.

    ```C
    // Callbacks для сокета.
    typedef struct {
        void (*OnBind)(int32_t socket, PeerSocketInfo info);
        void (*OnShutdown)(int32_t socket, ShutdownReason reason);
        void (*OnBytes)(int32_t socket, const void *data, uint32_t dataLen);
        void (*OnMessage)(int32_t socket, const void *data, uint32_t dataLen);
        void (*OnStream)(int32_t socket, const StreamData *data, const StreamData *ext, const StreamFrameInfo *param);
        void (*OnFile)(int32_t socket, FileEvent *event);
        void (*OnQos)(int32_t socket, QoSEvent eventId, const QosTV *qos, uint32_t qosCount);
        void (*OnError)(int32_t socket, int32_t errCode);
        void (*OnBytesSent)(int32_t socket, uint32_t dataSeq, int32_t errCode);
    } ISocketListener;
    ```

    ```c
    typedef enum {
        QOS_TYPE_MIN_BW,            // Минимальная пропускная способность.
        QOS_TYPE_MAX_WAIT_TIMEOUT,  // Время ожидания соединения.
        QOS_TYPE_MIN_LATENCY,       // Минимальная задержка соединения.
        QOS_TYPE_RTT_LEVEL,         // Уровень времени обратной передачи (RTT).
        QOS_TYPE_MAX_BUFFER,        // Максимальный буфер (зарезервировано).
        QOS_TYPE_FIRST_PACKAGE,     // Размер первого пакета (зарезервировано).
        QOS_TYPE_MAX_IDLE_TIMEOUT,  // Максимальное время бездействия.
        QOS_TYPE_TRANS_RELIABILITY, // Надёжность передачи (зарезервировано).
        QOS_TYPE_BUTT,
    } QosType;
    ```    typedef struct {
        QosType qos;
        int32_t value;
    } QosTV;

    // Start listening on the server socket.
    int32_t Listen(int32_t socket, const QosTV qos[], uint32_t qosCount, const ISocketListener *listener);

    // Binding of the client socket.
    int32_t Bind(int32_t socket, const QosTV qos[], uint32_t qosCount, const ISocketListener *listener);
    ```

4. Sending data to the receiving device via a socket.

    ```c
    // Sending bytes.
    int32_t SendBytes(int32_t socket, const void *data, uint32_t len);
    // Asynchronous sending of bytes. The dataSeq specifies the unique sequence number for the packet being sent and cannot be zero.
    int32_t SendBytesAsync(int32_t socket, uint32_t dataSeq, const void *data, uint32_t len);
    // Sending messages.
    int32_t SendMessage(int32_t socket, const void *data, uint32_t len);
    // Sending streams.
    int32_t SendStream(int32_t socket, const StreamData *data, const StreamData *ext, const StreamFrameInfo *param);
    // Sending files.
    int32_t SendFile(int32_t socket, const char *sFileList[], const char *dFileList[], uint32_t fileCnt);
    ```

4. Closing the socket.

    ```c
    // Closing the socket.
    void Shutdown(int32_t socket);
    ```

### Device Management

- Selection of the Wi-Fi keep-alive mode.

Invoke **ShiftLNNGear** on the DSoftBus client to launch the corresponding function **ShiftLNNGear** on the server through the IPC interface. The policy management module configures the **keepalive** property of the persistent TCP connection according to the specified policy.```c
typedef struct {
    ModeCycle cycle;             // Интервал проверки подключения.
    ModeDuration duration;       // Длительность режима работы.
    bool wakeupFlag;             // Признак того, что сигнал сердцебиения пробуждает устройство-получатель.
    ModeAction action;           // Действие, выполняемое во время процесса поддержания активности.
} GearMode;

typedef enum {
    HIGH_FREQ_CYCLE = 30,        // Интервал пульса сердца 30 секунд.
    MID_FREQ_CYCLE = 60,         // Интервал пульса сердца 60 секунд.
    LOW_FREQ_CYCLE = 5 * 60,     // Интервал пульса сердца 5 минут.
    DEFAULT_FREQ_CYCLE = 10 * 60,// Интервал пульса сердца 10 минут.
} ModeCycle;
```// Адаптация параметров keepalive TCP постоянной соединения в зависимости от указанного режима работы.
int32_t ShiftLNNGear(const char *pkgName, const char *callerId, const char *targetNetworkId, const GearMode *mode);

Продолжительность TCP keepalive зависит от **ModeCycle**.

```C
HIGH_FREQ_CYCLE = 30, // Продолжительность TCP keepalive составляет до 40 секунд.
MID_FREQ_CYCLE = 60, // Продолжительность TCP keepalive составляет до 70 секунд.
LOW_FREQ_CYCLE = 5 * 60, // Продолжительность TCP keepalive составляет до 315 секунд.
DEFAULT_FREQ_CYCLE = 10 * 60, // Продолжительность TCP keepalive составляет до 615 секунд.