Module sipuserdb_mysql

MySQL sipuserdb module.

Introduced in: 4 Aug 2005 by Magnus Ahltorp <ahltorp@nada.kth.se>

Behaviours: sipuserdb.

Authors: Magnus Ahltorp (ahltorp@nada.kth.se).

Description

MySQL sipuserdb module.

Function Index

get_addresses_for_user/1 Get all possible addresses of a user.
get_addresses_for_users/1 Iterate over a list of users, return all their addresses without duplicates by using the next function, get_addresses_for_user/1.
get_classes_for_user/1 Returns a list of classes allowed for a user.
get_forward_for_user/1 Return the forward address(es) for a user.
get_forwards_for_users/1 Return a list of forward addresses for a list of users.
get_password_for_user/1 Returns the password for a user.
get_telephonenumber_for_user/1 Return the telephone number for a user.
get_user_with_address/1 Looks up exactly one user with an Address.
get_users_for_address_of_record/1 Get all usernames of users matching an address.
get_users_for_addresses_of_record/1 Iterate over a list of addresses of record, return all users matching one or more of the addresses, without duplicates.
get_users_for_url/1 Given an URL that is typically the Request-URI of an incoming request, make a list of implicit user addresses and return a list of all users matching any of these addresses.
make_sql_statement/2 Construct an SQL query statement given a configuration parameter name or a string template.

Function Details

get_addresses_for_user/1

get_addresses_for_user(User::Username) -> Addresses | error

Get all possible addresses of a user. Both configured ones, and implicit ones. Used for example to check if a request from a user has an acceptable From: header.

get_addresses_for_users/1

get_addresses_for_users(In) -> Addresses

Iterate over a list of users, return all their addresses without duplicates by using the next function, get_addresses_for_user/1.

get_classes_for_user/1

get_classes_for_user(User::Username) -> Classes | nomatch | error

Returns a list of classes allowed for a user. Classes are used by pstnproxy to determine if it should allow a call to a PSTN number (of a certain class) from a user or not.

get_forward_for_user/1

get_forward_for_user(User::Username) -> ForwardList | nomatch | error

Return the forward address(es) for a user.

get_forwards_for_users/1

get_forwards_for_users(In) -> ForwardList

Return a list of forward addresses for a list of users. Uses the next function, get_forward_for_user/1.

get_password_for_user/1

get_password_for_user(User::Username) -> Password | nomatch | error

Returns the password for a user.

get_telephonenumber_for_user/1

get_telephonenumber_for_user(User::Username) -> Number | nomatch | error

Return the telephone number for a user. Return the number as a string which is probably an E.164 number or just a string with digits. The numbering plan in the number return is not specified.

get_user_with_address/1

get_user_with_address(Address) -> Username | nomatch | error

Looks up exactly one user with an Address. Used for example in REGISTER. If there are multiple users with this address in our database, this function returns 'error'.

get_users_for_address_of_record/1

get_users_for_address_of_record(Address) -> Users | error

Get all usernames of users matching an address. Used to find out to which users we should send a request.

get_users_for_addresses_of_record/1

get_users_for_addresses_of_record(AddressList::In) -> Users

Iterate over a list of addresses of record, return all users matching one or more of the addresses, without duplicates.

get_users_for_url/1

get_users_for_url(URL) -> Usernames

Given an URL that is typically the Request-URI of an incoming request, make a list of implicit user addresses and return a list of all users matching any of these addresses. This is located in here since user database backends can have their own way of deriving addresses from a Request-URI.

make_sql_statement/2

make_sql_statement(CfgKey::In, Args) -> Query

Construct an SQL query statement given a configuration parameter name or a string template. If Args consists of more than one element, SQL ' or ' will be used.


Generated by EDoc, Oct 17 2007, 16:48:18.