View Source TMI.MessageServer (tmi.ex v0.7.0)

A GenServer for Sending messages at a specified rate to a single channel.

Options

:rate (integer) - The rate at which to send the messages. (one message per rate). Optional. Defaults to 1500 ms.

Twitch command and message rate limits:

If command and message rate limits are exceeded, an application cannot send channel messages or commands for 30 minutes.

| Limit                         | Applies to
|-------------------------------|---------------------------------------------
| 20 per 30 seconds             | Users sending commands or messages to
|                               | channels in which they are not the broadcaster
|                               | and do not have Moderator status.
|                               |
| 100 per 30 seconds            | Users sending commands or messages to channels
|                               | in which they are the broadcaster or have
|                               | Moderator status.
|                               |
| 7500 per 30 seconds           | Verified bots. The channel limits above also
| site-wide                     | apply. In other words, one of the two limits
|                               | above will also be applied depending on
|                               | whether the verified bot is the broadcaster
|                               | or has Moderator status.

https://dev.twitch.tv/docs/irc/guide#rate-limits

Summary

Functions

add_command(name, command)

Add a command to the outbound message queue.

add_command(bot, channel, command)

Add a command to the outbound message queue.

add_message(name, message)

Add a message to the outbound message queue.

add_message(bot, channel, message)

Add a message to the outbound message queue.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

handle_cast(msg, state)

Invoked to handle asynchronous cast/2 messages.

handle_info(msg, state)

Invoked to handle all other messages.

init(arg)

Invoked when the server is started. start_link/3 will block until it returns.

module_name(bot, channel)

Generate the bot and channel specific module name.

start_link(arg)

Start the message server. Usually because of a JOIN.

stop(name)

Stop the message server. Usually because of a PART.

stop(bot, channel)

Stop the message server. Usually because of a PART.

supervisor_name(bot)

Generate the bot and channel specific module name.

update_mod_status(name, is_mod)

Update the mod status of the bot for the channel.

Functions

add_command(name, command)

@spec add_command(module(), String.t()) :: :ok

Add a command to the outbound message queue.

add_command(bot, channel, command)

@spec add_command(module(), String.t(), String.t()) :: :ok

Add a command to the outbound message queue.

add_message(name, message)

@spec add_message(module(), String.t()) :: :ok

Add a message to the outbound message queue.

add_message(bot, channel, message)

@spec add_message(module(), String.t(), String.t()) :: :ok

Add a message to the outbound message queue.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

handle_cast(msg, state)

Invoked to handle asynchronous cast/2 messages.

handle_info(msg, state)

Invoked to handle all other messages.

For example calling Process.send_after(self(), :foo, 1000) would send :foo after one second, and we could match on that here.

init(arg)

Invoked when the server is started. start_link/3 will block until it returns.

module_name(bot, channel)

@spec module_name(module(), String.t()) :: module()

Generate the bot and channel specific module name.

start_link(arg)

@spec start_link({module(), String.t(), boolean(), TMI.Conn.t()}) ::
  GenServer.on_start()

Start the message server. Usually because of a JOIN.

stop(name)

@spec stop(module()) :: :ok

Stop the message server. Usually because of a PART.

stop(bot, channel)

@spec stop(module(), String.t()) :: :ok

Stop the message server. Usually because of a PART.

supervisor_name(bot)

@spec supervisor_name(module()) :: module()

Generate the bot and channel specific module name.

update_mod_status(name, is_mod)

Update the mod status of the bot for the channel.