Multicast#

Functions#

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

According to command type, this API will 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 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)

According to command type, this API will send multicast group join or leave. This is a blocking API.

Parameters
[in]flags

- Select version use 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) – 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 -3 - Command given in wrong state -4 - Buffer not available to serve the command

Note

  • Device supports only one Multicast group. Must leave the previous group, if joining a new Multicast group


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

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 -3 - Command given in wrong state -4 - Buffer not available to serve the command 

                 If return value is greater than 0 \n
             0x0021,0x002C,0x0015,0xBB16,0xBB17

Note

  • Device supports only one Multicast group. Must leave the previous group, if joining a new Multicast group Refer to Error Codes section for the description of the above error codes Error Codes.


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

rsi_send_raw_data#

int32_t rsi_send_raw_data (uint8_t *buffer, uint32_t length)

Send RAW data to 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 Negative Value - Failure


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