oversip-mod-mysql
Overview
oversip-mod-mysql
provides an easy to use MySQL connector for OverSIP proxy based on mysql2 driver.
Starting from version 0.1.0 oversip-mod-mysql
depends on OverSIP >= 1.3.0 which enforces the usage of "sync" style coding via em-synchrony Gem.
- For more information about
em-synchrony
usage check Untangling Evented Code with Ruby Fibers.
Check the mysql2 documentation for the exact syntax and usage of the MySQL queries.
API
Method OverSIP::Modules::Mysql.add_pool(options)
Creates a MySQL connection pool by receiving a mandatory options
(a Hash
) with the following fields:
-
:pool_name
: Mandatory field. Must be aSymbol
with the name for this pool. -
:pool_size
: The number of parallel MySQL connections to perform. By default 10. - The rest of the fields will be passed to each
Mysql2::EM::Client.new
being created.
The method allows passing a block which would be later called by passing as argument each generated Mysql2::EM::Client
instance.
The created connection pool accepts calls to any method defined for Mysql2::EM::Client
class instance.
Method OverSIP::Modules::Mysql.pool(pool_name)
Retrieves a previously created pool with the given name. Raises an ArgumentError
if the given name does not exist in the list of created pools.
Usage Example
On top of /etc/oversip/server.rb
:
require "oversip-mod-mysql"
Within the OverSIP::SipEvents.on_initialize()
method in /etc/oversip/server.rb
:
def (OverSIP::SystemEvents).on_initialize
OverSIP::M::Mysql.add_pool({
:pool_name => :my_db,
:pool_size => 5,
:host => "localhost",
:username => "oversip",
:password => "xxxxxx",
:database => "oversip"
}) {|conn| log_info "MySQL created connection: #{conn.inspect}" }
end
Somewhere within the OverSIP::SipEvents.on_request()
method in /etc/oversip/server.rb
:
pool = OverSIP::M::Mysql.pool(:my_db)
begin
result = pool.query "SELECT * FROM users WHERE user = \'#{request.from.user}\'"
log_info "DB query result: #{result.to_a.inspect}"
if result.any?
# Add a X-Header with value the 'custom_header' field of the table row:
request.set_header "X-Header", result.first["custom_header"]
proxy = ::OverSIP::SIP::Proxy.new :proxy_out
proxy.route request
return
else
request.reply 404, "User not found in DB"
return
end
rescue ::Mysql2::Error => e
log_error "DB query error:"
log_error e
request.reply 500, "DB query error"
return
end
Limitations
mysql2 driver has auto reconnection support (which is forced by oversip-mod-mysql
by setting the field options[:reconnect] => true
). Unfortunatelly the auto reconnect feature of mysql2
driver is blocking which means that, in case the MySQL server goes down, OverSIP will get frozen during the auto reconnection attempt.
Dependencies
- Ruby > 1.9.2.
- oversip Gem >= 1.3.7.
- MySQL development library (the package
libmysqlclient-dev
in Debian/Ubuntu).
Installation
~$ gem install oversip-mod-mysql
Author
IƱaki Baz Castillo
- Mail: ibc@aliax.net
- Github profile: @ibc