一起读nodejs(七)----事件(Events)

本文是对nodejs0.8.9版本的api开发手册解读.nodejs网址

事件(Events)

stability:4 - API Frozen

在node里许多对象都发出事件:一个net.Server对象每次一个连接到来,都发出一个事件,一个fs.readStream对象在文件打开时放出一个事件.所有能放出事件的对象都是event.EventEmitter对象的实例.你可以这样做来访问这个模块:requre('events');

代表性的事件命名都是一个驼峰标识的字符串,然而这并不是一个强制约束,任何字符串都可以被接受.

函数可以被附加在对象上,并且当一个事件发出时被执行.这样的函数叫做监听函数.

Class:events.EventEmitter

可以这样访问events.EventEmitter类,require('events').EventEmitter.

当一个EventEmitter遇到一个错误时,典型的动作时发出一个error事件.在node里面,error事件将会被作为特殊情况处理,如果没有相应的监听函数,默认的动作是打印堆栈信息,然后退出程序.

当所有的EventEmitter对象在添加新的监听函数时都会发出newListener事件.

 

emitter.addListener(event,listener)

emitter.on(event,listener)

添加一个监听函数到指定的事件的监听函数数组的末尾.

server.on('connection', function (stream) {
  console.log('someone connected!');
});

emitter.once(event,listener)

 

为事件添加一个只执行一次的监听函数.这个监听函数只会在下次事件触发时执行一次,之后将会被移除.

server.once('connection', function (stream) {
  console.log('Ah, we have our first user!');
});

 

emitter.removeListener(event,listener)

在指定事件的监听函数数组中移除一个监听函数.注意:移除之后,将会改变在被移除监听函数之后的其他监听函数的数组索引.

var callback = function(stream) {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

 

emitter.removeAllListeners([event])

不带参数的话,会移除所有的监听函数,但参数的话只移除指定事件的所有监听函数.

注意:在之前使用emitter.listeners(event)获得的数组都将会无效.

 

emitter.setMaxListeners(n)

默认情况下,如果一个事件的监听函数超过10个,EventEmitters对象将会打印一个警告信息.这是一个发现内存溢出很有用的方法.很明显不是所有的Emitters对象都应该限制10个监听器.这个函数将会允许增加限制个数,如果不想限制个数,可以设置为0.

 

emitter.listeners(event)

返回指定事件的监听函数数组.

server.on('connection', function (stream) {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection'))); // [ [Function] ]

在事件机制下,这个数组是易变的,会保持和事件的监听函数列表一直,然而,特定的动作(特别是removeAllListeners)将会是这个索引无效.

 

如果你需要在指定的时间获得一个不会改变的监听函数列表的copy,拿到一个副本,例如可以这么做:emitter.listeners(event).slice(0).

在node将来的release版本中,这个行为将会改变成总是返回一个不变的copy,在你的程序中,请不要依赖通过数组的函数来修改EventEmitters的监听函数.请总是使用'on'方法来添加一个新的监听.

 

emitter.emit(event,[arg1],[arg2],[...])

根据提供的参数列表来顺序执行每一个监听函数.

Event:'newListener'

 

• event String,the event name,事件字符串,事件的名字.
• listener function the event handler function 监听函数,事件处理函数.

当任何一个对象(支持发出事件的)添加一个新监听函数时,将会发出这个事件.