larvit/smpp-js
3
0
Fork 0
Code Issues Pull Requests Actions Activity

Better documentation and removed old index file

Browse Source
This commit is contained in:
Lilleman auf Larv
2015-05-01 16:14:16 +02:00
parent 514ba28f0c
commit 0c27fae135
2 changed files with 51 additions and 234 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+51 -14
View File
@@ -80,6 +80,55 @@ This will setup a password less server on localhost, port 2775 and console.log()
});
});
### With auth, returning smsId and DLR
Example code below:
// This should of course be replaced with your preferred auth system
function checkuserpass(username, password, callback) {
if (username === 'foo' && password === 'bar') {
callback(null, true);
} else {
callback(null, false);
}
}
larvitsmpp.server({
'checkuserpass': checkuserpass
}, function(err, serverSession) {
if (err) {
throw err;
}
// Incoming SMS!
serverSession.on('sms', function(sms, callback) {
// It is important to run the callback since this is a part of the protocol
callback({
// Decimal value status code
// Default is 0 == no error
// See SMPP spec for all available status codes
// For example: 11 == 0000000B == ESME_RINVDSTADR == "Invalid destination address".
'status': 0,
// Set SMS id, this is important if DLR is to be connected with the right SMS but is not mandatory
'smsId': 450
});
// Oh, the sms sender wants a dlr (delivery report), send it!
if (sms.dlr === true) {
serverSession.sendDlr({
'smsId': 450,
'status': 0 // 0 == no error, 1 == error. No other values are allowed
});
}
});
});
### Events
#### connect
@@ -98,18 +147,6 @@ Triggered when the socket is closed
Generic error event
## Advanced server
#### sms
This example and its comments covers a lot of configuration options.
var larvitsmpp = require('larvitsmpp');
larvitsmpp.server(function(err, serverSession) {
if (err) {
throw err;
}
serverSession.on('data', function(data) {
console.log('command: ' + data.command);
});
});
Incoming SMS
larvitsmpp_old.js
-220
View File
@@ -1,220 +0,0 @@
/**
* SMPP Wrapper
*
* Error codes: http://www.activexperts.com/activsms/sms/smpperrorcodes/
*/
'use strict';
var log = require('winston'),
merge = require('utils-merge'),
smpp = require('smpp');
/**
* Set up SMPP server
*
* @param obj options
* * port - what port to bind to, defaults to 2775
* * checkUserAndPass - to require username and password to bind
* to this server this should be a function, taking three
* parameters: username, password and callback(err)
* * timeout - number of ms before the link should be considered dead. Defaults to 30000 (30 sec)
*
*/
exports.server = function(options) {
options = merge({
'port': 2775,
'checkUserAndPass': false,
'timeout': 30000
}, options);
smpp.createServer(function(smppSession) {
var loggedIn = false,
killTimer;
log.debug('larvitsmpp: server() - server session started');
function resetKillTimer() {
log.silly('larvitsmpp: server() - Resetting the kill timer');
if (killTimer) {
clearTimeout(killTimer);
}
killTimer = setTimeout(function() {
log.warn('larvitsmpp: server() - Closing session due to timeout');
smppSession.close();
}, options.timeout);
}
resetKillTimer();
/**
* Set logged in to true
*/
function login(pdu) {
loggedIn = true;
smppSession.send(pdu.response({
'command_status': smpp.ESME_ROK
}));
smppSession.resume();
}
/**
* General bind function for bind_receiver, bind_transmitter and bind_transceiver
*
* @param obj pdu
*/
function bindGeneral(pdu) {
if (options.checkUserAndPass instanceof Function) {
// We pause the smppSession to prevent further incoming pdu events,
// Untill we authorize the smppSession with some async operation.
smppSession.pause();
log.debug('larvitsmpp: server() - Checking username and password');
options.checkUserAndPass(pdu.system_id, pdu.password, function(err) {
if (err) {
log.warn('larvitsmpp: server() - Wrong username or password. Username: "' + pdu.system_id + '"');
smppSession.send(pdu.response({
'command_status': smpp.ESME_RBINDFAIL
}));
smppSession.close();
loggedIn = false;
return;
}
log.debug('larvitsmpp: server() - Username and password is ok');
login(pdu);
smppSession.resume();
});
} else {
login(pdu);
}
}
smppSession.on('error', function() {
log.error('larvitsmpp: server() - smppSession error!', arguments);
});
smppSession.on('pdu', function(pdu) {
log.silly('larvitsmpp: server() - Received command "' + pdu.command + '"');
resetKillTimer();
if (pdu.command === 'bind_receiver' || pdu.command === 'bind_transmitter' || pdu.command === 'bind_transceiver') {
bindGeneral(pdu);
} else if (pdu.command !== 'enquire_link') {
if (loggedIn) {
log.error('larvitsmpp: server() - Unkown command!', pdu);
console.log('PDU!!!!');
console.log(arguments);
} else {
log.warn('larvitsmpp: server() - Not logged in but trying to send non-bind command');
smppSession.send(pdu.response({
'command_status': smpp.ESME_RSERTYPUNAUTH
}));
}
}
});
smppSession.on('enquire_link', function(pdu) {
var sendRet;
log.silly('larvitsmpp: server() - Enquire_link - client heart beat.');
sendRet = smppSession.send(pdu.response({
'command_status': smpp.ESME_ROK
}));
if ( ! sendRet) {
// No writeable socket, do something!
}
});
}).listen(options.port);
};
/**
* Connect as a client to an SMPP server
*
* @param obj options
* * host (default 127.0.0.1)
* * port (default 2775)
* * username (default false)
* * password (default false)
* * mode (default 'transceiver', other options: 'receiver', 'transmitter')
* * heartbeat - set the heartbeat interval (default 10000)
* @param func callback(err, returnObj)
*/
exports.client = function(options, callback) {
var smppSession,
heartbeatTimer,
err,
returnObj = {'smppSession': smppSession},
bindOptions = {};
function heartbeat() {
log.silly('larvitsmpp: client() - heartbeat() - called');
smppSession.enquire_link();
heartbeatTimer = setTimeout(heartbeat, options.heartbeat);
// Here we need a timeout and then we need to reconnect
}
returnObj.close = function() {
clearTimeout(heartbeatTimer);
smppSession.close();
};
options = merge({
'host': '127.0.0.1',
'port': 2775,
'username': undefined,
'password': undefined,
'mode': 'transceiver',
'heartbeat': 10000
}, options);
log.info('larvitsmpp: client() - Connecting to SMPP server at ' + options.host + ':' + options.port);
smppSession = smpp.connect(options.host, options.port);
if (options.username !== undefined && options.password !== undefined) {
bindOptions.system_id = options.username;
bindOptions.password = options.password;
}
if (options.mode === 'transceiver') {
log.error('bajs');
} else if (options.mode === 'receiver') {
log.error('skabb');
} else if (options.mode === 'transmitter') {
smppSession.bind_transmitter(bindOptions, function(pdu) {
var err;
log.info('larvitsmpp: client() - bind_transmitter done.');
if (pdu.command_status === 0) {
log.info('larvitsmpp: client() - bind_transmitter returned 0, success!');
heartbeat();
callback(null, returnObj);
} else {
err = new Error('models/smppsend.js: bind_transmitter returned "' + pdu.command_status + '", fail!');
log.warn(err.message, pdu);
smppSession.close();
callback(err);
}
});
} else {
err = new Error('larvitsmpp: client() - Invalid connection mode');
log.error(err.message);
callback(err);
}
smppSession.on('pdu', function(pdu) {
log.silly('larvitsmpp: client() - Received command "' + pdu.command + '"');
});
};