Fivebeans: различия между версиями

Материал из support.qbpro.ru
imported>Supportadmin
Нет описания правки
imported>Supportadmin
Строка 41: Строка 41:


===Producing jobs===
===Producing jobs===
====use====
client.use(tube, function(err, tubename) {});
Use the specified tube. Reponds with the name of the tube being used.
====list_tube_used====
client.list_tube_used(function(err, tubename) {});
Responds with the name of the tube currently being used by the client.
====put====
client.put(priority, delay, ttr, payload, function(err, jobid) {});
Submit a job with the specified priority (smaller integers are higher priority), delay in seconds, and allowed time-to-run in seconds. The payload contains the job data the server will return to clients reserving jobs; it can be either a Buffer object or a string. No processing is done on the data. Responds with the id of the newly-created job.
====peek_ready====
client.peek_ready(function(err, jobid, payload) {});
Peek at the data for the job at the top of the ready queue of the tube currently in use. Responds with the job id and payload of the next job, or 'NOT_FOUND' if there are no qualifying jobs in the tube. The payload is a Buffer object.
====peek_delayed====
client.peek_delayed(function(err, jobid, payload) {});
Peek at the data for the delayed job with the shortest delay in the tube currently in use. Responds with the job id and payload of the next job, or 'NOT_FOUND' in err if there are no qualifying jobs in the tube. The payload is a Buffer object.
====peek_buried====
client.peek_buried(function(err, jobid, payload) {});
Peek at the data for the next buried job in the tube currently in use. Responds with the job id and payload of the next job, or 'NOT_FOUND' in err if there are no qualifying jobs in the tube. The payload is a Buffer object.
===Consuming jobs===
===Consuming jobs===
===Server statistics===
===Server statistics===

Версия от 17:35, 11 мая 2014

beanstalkd client & worker daemon for node

оригинал

FiveBeansClient

Heavily inspired by node-beanstalk-client, which is a perfectly usable client but somewhat dusty. I wanted more complete support of the beanstalkd protocol in a project written in plain javascript.

All client method names are the same case & spelling as the beanstalk text command, with hyphens replaced by underscore. The single exception is delete, which is renamed to destroy().

For complete details on the beanstalkd commands, see its protocol documentation.

Creating a client

The client constructor takes two arguments:

  • host: The address of the beanstalkd server. Defaults to 127.0.0.1.
  • port: Port to connect to. Defaults to 11300.

The client emits three events that you should listen for: connect, error, and close.

The client is not usable until you call its connect() method. Here's an example of setting up a client:

var fivebeans = require('fivebeans');

var client = new fivebeans.client('10.0.1.1', 11300);
client
    .on('connect', function()
    {
        // client can now be used
    })
    .on('error', function(err)
    {
        // connection failure    
    })
    .on('close', function()
    {
        // underlying connection has closed
    })
    .connect();

Producing jobs

use

client.use(tube, function(err, tubename) {});

Use the specified tube. Reponds with the name of the tube being used.

list_tube_used

client.list_tube_used(function(err, tubename) {});

Responds with the name of the tube currently being used by the client.

put

client.put(priority, delay, ttr, payload, function(err, jobid) {});

Submit a job with the specified priority (smaller integers are higher priority), delay in seconds, and allowed time-to-run in seconds. The payload contains the job data the server will return to clients reserving jobs; it can be either a Buffer object or a string. No processing is done on the data. Responds with the id of the newly-created job.

peek_ready

client.peek_ready(function(err, jobid, payload) {});

Peek at the data for the job at the top of the ready queue of the tube currently in use. Responds with the job id and payload of the next job, or 'NOT_FOUND' if there are no qualifying jobs in the tube. The payload is a Buffer object.

peek_delayed

client.peek_delayed(function(err, jobid, payload) {});

Peek at the data for the delayed job with the shortest delay in the tube currently in use. Responds with the job id and payload of the next job, or 'NOT_FOUND' in err if there are no qualifying jobs in the tube. The payload is a Buffer object.

peek_buried

client.peek_buried(function(err, jobid, payload) {});

Peek at the data for the next buried job in the tube currently in use. Responds with the job id and payload of the next job, or 'NOT_FOUND' in err if there are no qualifying jobs in the tube. The payload is a Buffer object.

Consuming jobs

Server statistics

FiveBeansWorker

API

constructor

Events

Jobs

Handlers

Example

FiveBeansRunner

bin/beanworker

Configuration file