Module mod_muc [erl svg]

Function Index
Function Details

Behaviours: gen_mod, gen_server.

Function Index

broadcast_service_message/2
can_use_nick/3
check_user_can_create_room/4*
code_change/3
create_room/5	Create a room.
do_route/9*
do_route1/9*
flush/0*
forget_room/2
get_room_pos/2*	Return the position of desired room in the list of rooms.
get_room_pos/3*
get_vh_rooms/1
get_vh_rooms/2*
get_vh_rooms_all_nodes/1*
get_vh_rooms_direction/4*
handle_call/3
handle_cast/2
handle_info/2
init/1
iq_disco_info/1*
iq_disco_items/4*
iq_get_register_info/3*
iq_get_unique_el/1*
iq_get_unique_name/1*	Get a pseudo unique Room Name.
iq_get_vcard/1*
iq_set_register_info/4*
l2b/1*
load_permanent_rooms/5*
migrate/1
process_iq_disco_items/4
process_iq_register_set/4*
register_room/3
register_room_internal/3*
remove_host/1
restore_room_internal/2*
room_destroyed/4
start/2
start_link/2
start_new_room/9*
start_supervisor/1*
stop/1
stop_supervisor/1*
store_room/3
terminate/2
update_tables/2*

Function Details

broadcast_service_message/2

broadcast_service_message(Host, Msg) -> any()

can_use_nick/3

can_use_nick(Host, JID, Nick) -> any()

check_user_can_create_room/4 *

check_user_can_create_room(ServerHost, AccessCreate, From, RoomID) -> any()

code_change/3

code_change(OldVsn, State, Extra) -> any()

create_room/5

create_room(Host, Name, From, Nick, Opts) -> any()

Create a room. If Opts = default, the default room options are used. Else use the passed options as defined in mod_muc_room.

do_route/9 *

do_route(Host, ServerHost, Access, HistorySize, RoomShaper, From, To, Packet, DefRoomOpts) -> any()

do_route1/9 *

do_route1(Host, ServerHost, Access, HistorySize, RoomShaper, From, To, Packet, DefRoomOpts) -> any()

get_room_pos/2 *

get_room_pos(Desired::muc_online_room(), Rooms::[muc_online_room()]) -> integer()

Return the position of desired room in the list of rooms. The room must exist in the list. The count starts in 0.

get_room_pos/3 *

get_room_pos(Desired, Rooms, HeadPosition) -> any()

get_vh_rooms_direction/4 *

get_vh_rooms_direction(Direction, I, Index, AllRooms) -> any()

iq_disco_items/4 *

iq_disco_items(Host, From, Lang, Rsm) -> any()

iq_get_register_info/3 *

iq_get_register_info(Host, From, Lang) -> any()

iq_get_unique_name/1 *

iq_get_unique_name(From) -> any()

Get a pseudo unique Room Name. The Room Name is generated as a hash of the requester JID, the local time and a random salt.

"pseudo" because we don't verify that there is not a room with the returned Name already created, nor mark the generated Name as "already used". But in practice, it is unique enough. See http://xmpp.org/extensions/xep-0045.html#createroom-unique