Softbus

    This module implements unified distributed communication capability management between nearby devices, and provides link-independent device discovery and transmission interfaces to support service publishing and data transmission.

    Since:

    1.0

    Version:

    1.0

    Summary

    Files

    Data Structures

    Data Structure Name

    Description

    Defines service provisioning information sent to a discovering device.

    CapabilityMap

    Defines the mapping between supported capabilities and bitmaps.

    Defines the mappings between the device type enumerations and device type names.

    IPublishCallback

    Defines the callbacks for successful and failed service publishing.

    Defines the type and content of a device to set.

    ISessionListener

    Defines session callbacks.

    Typedefs

    Typedef Name

    Description

    typedef struct PublishInfo 

    Defines service provisioning information sent to a discovering device.

    typedef enum DeviceTypeEnum 

    Enumerates device types.

    typedef struct IPublishCallback 

    Defines the callbacks for successful and failed service publishing.

    typedef struct CommonDeviceInfo 

    Defines the type and content of a device to set.

    Enumerations

    Enumeration Name

    Description

    { AUTO = 0, = 1, COAP = 2, = 3 }

    Enumerates media, such as Bluetooth, Wi-Fi, and USB, used for publishing services.

    ExchangeFre { = 0, MID = 1, = 2, SUPER_HIGH = 3 }

    Enumerates frequencies for publishing services. This enumeration is involved only in Bluetooth and is not supported currently.

    { DISCOVER_MODE_PASSIVE = 0x55, = 0xAA }

    Enumerates the modes in which services are published. The publishing service supports the passive mode. Lite devices support the passive mode only.

    PublishFailReason { = 1, PUBLISH_FAIL_REASON_PARAMETER_INVALID = 2, = 0xFF }

    Enumerates failure reasons for publishing services.

    DataBitMap {    = 0, PROFILE_CAPABILITY_BITMAP = 1, = 2, CASTPLUS_CAPABILITY_BITMAP,   , DVKIT_CAPABILITY_BITMAP, }

    Enumerates supported capabilities published by a device.

    DeviceTypeEnum {    = 0x00, PHONE = 0x0E, = 0x11, TV = 0x9C,    = 0x0C, AUDIO = 0x0A, = 0x83, L0 = 0xF1,    = 0xF2 }

    Enumerates device types.

    CommonDeviceKey { = 0, COMM_DEVICE_KEY_DEVTYPE = 1, = 2, COMM_DEVICE_KEY_MAX }

    Enumerates device information, such as its ID, type, and name.

    Functions

    Function Name

    Description

    (const char moduleName, const struct PublishInfo info, const struct cb)

    int 

    Publishes a service to the discovering device in the LAN.

    UnPublishService (const char moduleName, int publishId)

    int 

    Unpublishes a service based on the publicId and moduleName.

    (const struct CommonDeviceInfo devInfo, unsigned int num)

    int 

    Sets common device information, such as its ID, type, and name.

    (const char mouduleName, const char sessionName, struct ISessionListener listener)

    int 

    Creates a session server based on a module name and session name.

    (const char mouduleName, const char sessionName)

    int 

    Removes a session server based on a module name and session name.

    SendBytes (int sessionId, const void data, unsigned int len)

    int 

    Sends data based on a session ID.

    (int sessionId, char sessionName, unsigned int len)

    int 

    Obtains the session name registered by the local device based on the session ID.

    GetPeerSessionName (int sessionId, char sessionName, unsigned int len)

    int 

    Obtains the session name registered by the peer device based on the session ID.

    (int sessionId, char devId, unsigned int len)

    int 

    Obtains the peer device ID based on a session ID.

    CloseSession (int sessionId)

    void 

    Closes a connected session based on a session ID.

    Details

    Typedef Documentation

    CommonDeviceInfo

    Description:

    Defines the type and content of a device to set.

    DeviceType

    Description:

    Enumerates device types.

    IPublishCallback

    1. typedef struct [IPublishCallback]($api-api-SmartVision-Devices-IPublishCallback.md) [IPublishCallback]($api-api-SmartVision-Devices-IPublishCallback.md)

    Description:

    Defines the callbacks for successful and failed service publishing.

    PublishInfo

    1. typedef struct [PublishInfo]($api-api-SmartVision-Devices-PublishInfo.md) [PublishInfo]($api-api-SmartVision-Devices-PublishInfo.md)

    Description:

    Defines service provisioning information sent to a discovering device.

    Enumeration Type Documentation

    CommonDeviceKey

    1. enum [CommonDeviceKey]($api-api-SmartVision-Devices-Softbus.md#ga25be99ffbe88e41f7ce51d2678010254)

    Description:

    Enumerates device information, such as its ID, type, and name.

    Enumerator

    Description
    COMM_DEVICE_KEY_DEVID 

    Device ID. The value contains a maximum of 64 characters.

    COMM_DEVICE_KEY_DEVTYPE 

    Device type. Currently, only ddmpCapability is supported.

    COMM_DEVICE_KEY_DEVNAME 

    Device name. The value contains a maximum of 63 characters.

    COMM_DEVICE_KEY_MAX 

    Reserved

    DataBitMap

    1. enum [DataBitMap]($api-api-SmartVision-Devices-Softbus.md#gab839c7f1fd448f52f003ab0693f27bb4)

    Description:

    Enumerates supported capabilities published by a device.

    Enumerator

    Description
    HICALL_CAPABILITY_BITMAP 

    MeeTime

    PROFILE_CAPABILITY_BITMAP 

    Video reverse connection in the smart domain

    HOMEVISIONPIC_CAPABILITY_BITMAP 

    Gallery in Vision

    CASTPLUS_CAPABILITY_BITMAP 

    cast+

    AA_CAPABILITY_BITMAP 

    Input method in Vision

    DVKIT_CAPABILITY_BITMAP 

    Device virtualization tool package

    DDMP_CAPABILITY_BITMAP 

    Distributed middleware

    DeviceTypeEnum

    1. enum [DeviceTypeEnum]($api-api-SmartVision-Devices-Softbus.md#gab20b49630026f3118d6c05b0a022f230)

    Description:

    Enumerates device types.

    Enumerator

    Description
    UNKOWN 

    Unknown

    PHONE 

    Smartphone

    PAD 

    Tablet

    TV 

    Smart TV

    PC 

    PC

    AUDIO 

    Audio device

    CAR 

    Vehicle-mounted device

    L0 

    Light device L0

    L1 

    Light device L1

      Description:

      Enumerates the modes in which services are published. The publishing service supports the passive mode. Lite devices support the passive mode only.

      ExchanageMedium

      1. enum [ExchanageMedium]($api-api-SmartVision-Devices-Softbus.md#gaf5c7c122990f0ab5bd46b9bc47b5868b)

      Description:

      Enumerates media, such as Bluetooth, Wi-Fi, and USB, used for publishing services.

      Currently, the media can only be set to coap.

      Enumerator

      Description
      AUTO 

      Automatic medium selection

      BLE 

      Bluetooth

      COAP 

      Wi-Fi

      USB 

      USB

      ExchangeFre

      1. enum [ExchangeFre]($api-api-SmartVision-Devices-Softbus.md#gacf2c77bd7e2c82784078762978123ea3)

      Description:

      Enumerates frequencies for publishing services. This enumeration is involved only in Bluetooth and is not supported currently.

      Enumerator

      Description
      LOW 

      Low

      MID 

      Medium

      HIGH 

      High

      SUPER_HIGH 

      Super-high

      PublishFailReason

      1. enum [PublishFailReason]($api-api-SmartVision-Devices-Softbus.md#ga6632fcae1db4a3a13370e3fb49e5e620)

      Description:

      Enumerates failure reasons for publishing services.

      The failure reason is returned to the caller through the callback function.

      Enumerator

      Description
      PUBLISH_FAIL_REASON_NOT_SUPPORT_MEDIUM 

      Unsupported medium

      PUBLISH_FAIL_REASON_PARAMETER_INVALID 

      Invalid parameter

      PUBLISH_FAIL_REASON_UNKNOWN 

      Unknown reason

      Function Documentation

      CloseSession()

      1. void CloseSession (int sessionId)

      Description:

      Closes a connected session based on a session ID.

      Parameters:

      Name

      Description
      sessionId Indicates the session ID.

      CreateSessionServer()

      1. int CreateSessionServer (const char * mouduleName, const char * sessionName, struct [ISessionListener]($api-api-SmartVision-Devices-ISessionListener.md) * listener )

      Description:

      Creates a session server based on a module name and session name.

      A maximum of 18 session servers can be created.

      Parameters:

      Name

      Description
      moduleName Indicates the pointer to the module name, which can be used to check whether the session server is in this module. The value cannot be empty and can contain a maximum of 64 characters.
      sessionName Indicates the pointer to the session name, which is the unique ID of the session server. The value cannot be empty and can contain a maximum of 64 characters.
      listener Indicates the pointer to the session callback structure, which cannot be empty.

      Returns:

      Returns 0 if the operation is successful; returns -1 otherwise.

      See also:

      GetMySessionName()

      Description:

      Obtains the session name registered by the local device based on the session ID.

      Parameters:

      Name

      Description
      sessionId Indicates the session ID.
      sessionName Indicates the pointer to the buffer for storing the session name.
      len Indicates the length of the buffer.

      Returns:

      Returns 0 if the operation is successful; returns -1 otherwise.

      GetPeerDeviceId()

      Description:

      Obtains the peer device ID based on a session ID.

      Parameters:

      Name

      Description
      sessionId Indicates the session ID.
      devId Indicates the pointer to the buffer for storing the device ID.
      len Indicates the length of the buffer.

      Returns:

      Returns 0 if the operation is successful; returns -1 otherwise.

      GetPeerSessionName()

      1. int GetPeerSessionName (int sessionId, char * sessionName, unsigned int len )

      Description:

      Obtains the session name registered by the peer device based on the session ID.

      Returns:

      Returns 0 if the operation is successful; returns -1 otherwise.

      PublishService()

      1. int PublishService (const char * moduleName, const struct [PublishInfo]($api-api-SmartVision-Devices-PublishInfo.md) * info, const struct [IPublishCallback]($api-api-SmartVision-Devices-IPublishCallback.md) * cb )

      Description:

      Publishes a service to the discovering device in the LAN.

      The publicId and moduleName uniquely identify a service. A maximum of three services can be published.

      Parameters:

      Name

      Description
      moduleName Indicates the pointer to the module name of the upper-layer service. The value contains a maximum of 63 bytes.
      info Indicates the pointer to the service to publish. For details, see PublishInfo.
      cb Indicates the pointer to the callback for service publishing. For details, see .

      Returns:

      Returns 0 if the operation is successful; returns -1 otherwise.

      RemoveSessionServer()

      1. int RemoveSessionServer (const char * mouduleName, const char * sessionName )

      Description:

      Removes a session server based on a module name and session name.

      Parameters:

      Name

      Description
      moduleName Indicates the pointer to the name of the registered module, which can be used to check whether the session server is in this module. The value cannot be empty and can contain a maximum of 64 characters.
      sessionName Indicates the pointer to the session name. The value cannot be empty and can contain a maximum of 64 characters.

      Returns:

      Returns 0 if the operation is successful; returns -1 otherwise.

      See also:

      CreateSessionServer

      SendBytes()

      1. int SendBytes (int sessionId, const void * data, unsigned int len )

      Description:

      Sends data based on a session ID.

      Parameters:

      Name

      Description
      sessionId Indicates the session ID.
      data Indicates the pointer to the data to send, which cannot be NULL.
      len Indicates the length of the data to send. The maximum length cannot exceed 984 characters.

      Returns:

      Returns 0 if the function is called successfully; returns -1 otherwise.

      SetCommonDeviceInfo()

      1. int SetCommonDeviceInfo (const struct [CommonDeviceInfo]($api-api-SmartVision-Devices-CommonDeviceInfo.md) * devInfo, unsigned int num )

      Description:

      Sets common device information, such as its ID, type, and name.

      Parameters:

      Name

      Description
      devInfo Indicates the pointer to the device information array.
      2 num Indicates the number of elements in the device information array. If the value is inconsistent with the length of the device information array, the program breaks down.

      Returns:

      Returns 0 if the operation is successful; returns a non-zero value otherwise.

      See also:

      UnPublishService()

      1. int UnPublishService (const char * moduleName, int publishId )

      Description:

      Unpublishes a service based on the publicId and moduleName.

      Parameters:

      Name

      Description
      moduleName Indicates the pointer to the module name of the upper-layer service. The value contains a maximum of 63 bytes.
      publishId Indicates the ID of the service to unpublish. The value must be greater than 0.

      Returns:

      Returns 0 if the operation is successful; returns a non-zero value otherwise.

      Variable Documentation

      bitmap

      1. [DataBitMap]($api-api-SmartVision-Devices-Softbus.md#gab839c7f1fd448f52f003ab0693f27bb4) CapabilityMap::bitmap

      Description:

      Bitmaps. For details, see DataBitMap. 

      1. const char* PublishInfo::capability

      Description:

      publishing capabilities. For details, see g_capabilityMap.

      capability [2/2]

      1. char* CapabilityMap::capability

      Description:

      Capability. For details, see g_capabilityMap.

      capabilityData

      1. unsigned char* PublishInfo::capabilityData

      Description:

      Capability data for service publishing

      dataLen

      1. unsigned int PublishInfo::dataLen

      Description:

      Maximum length of the capability data for service publishing (2 bytes)

      devType

      Description:

      Enumeration of a device type. Only enumerations defined in g_devMap are supported.

      freq

      Description:

      publishing frequency

      key

      1. [CommonDeviceKey]($api-api-SmartVision-Devices-Softbus.md#ga25be99ffbe88e41f7ce51d2678010254) CommonDeviceInfo::key

      Description:

      Device information type. For details, see .

      medium

      1. [ExchanageMedium]($api-api-SmartVision-Devices-Softbus.md#gaf5c7c122990f0ab5bd46b9bc47b5868b) PublishInfo::medium

      Description:

      publishing medium

      mode

      1. int PublishInfo::mode

      Description:

      publishing mode, which can be DISCOVER_MODE_PASSIVE or

      onBytesReceived

      1. void(* ISessionListener::onBytesReceived) (int sessionId, const void *data, unsigned int dataLen)

      Description:

      Called when data is received.

      This function is used to notify that data is received.

      Parameters:

      Name

      Description
      sessionId Indicates the session ID.
      data Indicates the pointer to the data received.
      dataLen Indicates the length of the data received.

      onPublishFail

      1. void(* IPublishCallback::onPublishFail) (int publishId, [PublishFailReason]($api-api-SmartVision-Devices-Softbus.md#ga6632fcae1db4a3a13370e3fb49e5e620) reason)

      Description:

      Callback for failed publishing

      onPublishSuccess

      1. void(* IPublishCallback::onPublishSuccess) (int publishId)

      Description:

      Callback for successful publishing

      onSessionClosed

      1. void(* ISessionListener::onSessionClosed) (int sessionId)

      Description:

      Called when a session is closed.

      This function can be used to release resources related to the session. You do not need to call .

      Parameters:

      Name

      Description
      sessionId Indicates the session ID.

      onSessionOpened

      1. int(* ISessionListener::onSessionOpened) (int sessionId)

      Description:

      Called when a session is opened.

      This function can be used to verify the session or initialize resources related to the session.

      Parameters:

      Returns:

      Returns 0 if the session connection is accepted; returns a non-zero value otherwise (you do not need to call to close the session).

      publishId

      1. int PublishInfo::publishId

      Description:

      publishing ID

      value [1/2]

      1. char* DeviceMap::value

      Description:

      Name of a device type. Only names defined in g_devMap are supported.

      value [2/2]

        Description: