Multicast#

Functions#

int32_t
rsi_multicast(uint8_t flags, int8_t *ip_address, uint8_t command_type)

Send multicast group join or leave. This is a blocking API.

int32_t
rsi_multicast_join(uint8_t flags, int8_t *ip_address)

Join to a multicast group. This is a blocking API.

int32_t
rsi_multicast_leave(uint8_t flags, int8_t *ip_address)

Leave the multicast group. This is a blocking API.

int32_t
rsi_send_raw_data(uint8_t *buffer, uint32_t length)

Send raw data to the module. This is a blocking API.

Function Documentation#

rsi_multicast#

static int32_t rsi_multicast (uint8_t flags, int8_t * ip_address, uint8_t command_type)

Send multicast group join or leave. This is a blocking API.

Parameters
[in]flags

- Select IP version. BIT(0) : 0 - IPv4 , 1 - IPv6

[in]ip_address

- Multicast IP address

[in]command_type

- Type of commands: JOIN/LEAVE

Returns

  • 0 - Success

  • Negative value - Failure


Definition at line 34 of file network/protocols/rsi_multicast.c

rsi_multicast_join#

int32_t rsi_multicast_join (uint8_t flags, int8_t * ip_address)

Join to a multicast group. This is a blocking API.

Parameters
[in]flags

- Select the IP version. BIT(0): 0 - IPv4 , 1 - IPv6

[in]ip_address

- IPv4/IPv6 address of multicast group.

Returns

  • 0 - Success

  • Negative Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc)

Note

  • Precondition - rsi_config_ipaddress() API needs to be called before this API.

  • Device supports only one multicast group. It must leave the previous group, to join a new multicast group.

  • Refer to Error Codes for the description of above error codes.


Definition at line 123 of file network/protocols/rsi_multicast.c

References RSI_SUCCESS , and SL_PRINTF

rsi_multicast_leave#

int32_t rsi_multicast_leave (uint8_t flags, int8_t * ip_address)

Leave the multicast group. This is a blocking API.

Parameters
[in]flags

- Select the IP version. BIT(0) – RSI_IPV6. Set this bit to enable IPv6. By default it is configured to IPv4.

[in]ip_address

- IPv4/IPv6 address of multicast group.

Returns

  • 0 - Success Negative Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021,0x002C,0x0015,0xBB16,0xBB17)

Note

  • Precondition - rsi_config_ipaddress() API needs to be called before this API.

  • Device supports only one multicast group. It must leave the previous group, to join a new multicast group.

  • Refer to Error Codes for the description of above error codes.


Definition at line 151 of file network/protocols/rsi_multicast.c

References RSI_SUCCESS , and SL_PRINTF

rsi_send_raw_data#

int32_t rsi_send_raw_data (uint8_t * buffer, uint32_t length)

Send raw data to the module. This is a blocking API.

Parameters
[in]buffer

- Pointer to the buffer to send

[in]length

- Length of the buffer to send

Returns

  • 0 - Success

  • Non-Zero Value - Failure


Definition at line 31 of file network/protocols/rsi_raw_data.c