BeanstalkClient (beanstalk client 2.3.0 API)

所有超级接口:

JobConsumer, JobProducer
```
public interface BeanstalkClient
extends JobConsumer, JobProducer
```
BeanstalkClient is a full amount interface, mainly used for management.

版本:

2.0.0.2013-8-12

作者:

guojf

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`close()` close the current connection and release resources. that's status is closed, and is no longer available.
`boolean`	`ignoreTube(String tube)` The "ignore" command is for consumers.
`long`	`kick(long bound)` The kick command applies only to the currently used tube.
`List<String>`	`listTubes()` The list-tubes command returns a list of all existing tubes.
`String`	`listTubeUsed()` The list-tube-used command returns the tube currently being used by the client.
`List<String>`	`listTubeWatched()` The list-tubes-watched command returns a list tubes currently being watched by the client.
`Job`	`peek(long jobId)` The peek commands let the client inspect a job in the system.
`Job`	`peekBuried()` The peek commands let the client inspect a job in the system, return the next job in the list of buried jobs.
`Job`	`peekDelayed()` The peek commands let the client inspect a job in the system, return the delayed job with the shortest delay left.
`Job`	`peekReady()` The peek commands let the client inspect a job in the system, return the next ready job.
`Map<String,String>`	`stats()` The stats command gives statistical information about the system as a whole.
`Map<String,String>`	`statsJob(long jobId)` The stats-job command gives statistical information about the specified job if it exists.
`Map<String,String>`	`statsTube(String tubeName)` The stats-tube command gives statistical information about the specified tube if it exists.
`boolean`	`useTube(String tube)` The "use" command is for producers.
`boolean`	`watchTube(String tube)` The "watch" command adds the named tube to the watch list for the current connection.

从接口继承的方法 com.dinstone.beanstalkc.JobConsumer
buryJob, deleteJob, releaseJob, reserveJob, touchJob

从接口继承的方法 com.dinstone.beanstalkc.JobProducer
putJob

- 方法详细资料
  - useTube
```
boolean useTube(String tube)
```
    The "use" command is for producers. Subsequent put commands will put jobs into the tube specified by this command. If no use command has been issued, jobs will be put into the tube named "default".
    
    参数:
    
    tube - is a name at most 200 bytes. It specifies the tube to use. If the tube does not exist, it will be created.
    
    返回:
  - ignoreTube
```
boolean ignoreTube(String tube)
```
    The "ignore" command is for consumers. It removes the named tube from the watch list for the current connection.
    
    参数:
    
    tube - is a name at most 200 bytes.
    
    返回:
  - watchTube
```
boolean watchTube(String tube)
```
    The "watch" command adds the named tube to the watch list for the current connection. A reserve command will take a job from any of the tubes in the watch list. For each new connection, the watch list initially consists of one tube, named "default".
    
    参数:
    
    tube -
    
    返回:
  - kick
```
long kick(long bound)
```
    The kick command applies only to the currently used tube. It moves jobs into the ready queue. If there are any buried jobs, it will only kick buried jobs. Otherwise it will kick delayed jobs.
    
    参数:
    
    bound -
    
    返回:
  - peek
```
Job peek(long jobId)
```
    The peek commands let the client inspect a job in the system.
    
    参数:
    
    jobId -
    
    返回:
  - peekReady
```
Job peekReady()
```
    The peek commands let the client inspect a job in the system, return the next ready job.
    
    返回:
  - peekDelayed
```
Job peekDelayed()
```
    The peek commands let the client inspect a job in the system, return the delayed job with the shortest delay left.
    
    返回:
  - peekBuried
```
Job peekBuried()
```
    The peek commands let the client inspect a job in the system, return the next job in the list of buried jobs.
    
    返回:
  - statsJob
```
Map<String,String> statsJob(long jobId)
```
    The stats-job command gives statistical information about the specified job if it exists.
    The stats-job data is a YAML file representing a single dictionary of strings to scalars. It contains these keys:
    - "id" is the job id
    - "tube" is the name of the tube that contains this job
    - "state" is "ready" or "delayed" or "reserved" or "buried"
    - "pri" is the priority value set by the put, release, or bury commands.
    - "age" is the time in seconds since the put command that created this job.
    - "time-left" is the number of seconds left until the server puts this job into the ready queue. This number is only meaningful if the job is reserved or delayed. If the job is reserved and this amount of time elapses before its state changes, it is considered to have timed out.
    - "timeouts" is the number of times this job has timed out during a reservation.
    - "releases" is the number of times a client has released this job from a reservation.
    - "buries" is the number of times this job has been buried.
    - "kicks" is the number of times this job has been kicked.
    
    参数:
    
    jobId -
    
    返回:
    
    a sequence of bytes. It is a YAML file with statistical information represented a dictionary.
  - statsTube
```
Map<String,String> statsTube(String tubeName)
```
    The stats-tube command gives statistical information about the specified tube if it exists.
    The stats-tube data is a YAML file representing a single dictionary of strings to scalars. It contains these keys:
    - "name" is the tube's name.
    - "current-jobs-urgent" is the number of ready jobs with priority < 1024 in this tube.
    - "current-jobs-ready" is the number of jobs in the ready queue in this tube.
    - "current-jobs-reserved" is the number of jobs reserved by all clients in this tube.
    - "current-jobs-delayed" is the number of delayed jobs in this tube.
    - "current-jobs-buried" is the number of buried jobs in this tube.
    - "total-jobs" is the cumulative count of jobs created in this tube.
    - "current-waiting" is the number of open connections that have issued a reserve command while watching this tube but not yet received a response.
    
    参数:
    
    tubeName -
    
    返回:
  - stats
```
Map<String,String> stats()
```
    The stats command gives statistical information about the system as a whole.
    The stats data for the system is a YAML file representing a single dictionary of strings to scalars. It contains these keys:
    - "current-jobs-urgent" is the number of ready jobs with priority < 1024.
    - "current-jobs-ready" is the number of jobs in the ready queue.
    - "current-jobs-reserved" is the number of jobs reserved by all clients.
    - "current-jobs-delayed" is the number of delayed jobs.
    - "current-jobs-buried" is the number of buried jobs.
    - "cmd-put" is the cumulative number of put commands.
    - "cmd-peek" is the cumulative number of peek commands.
    - "cmd-peek-ready" is the cumulative number of peek-ready commands.
    - "cmd-peek-delayed" is the cumulative number of peek-delayed commands.
    - "cmd-peek-buried" is the cumulative number of peek-buried commands.
    - "cmd-reserve" is the cumulative number of reserve commands.
    - "cmd-use" is the cumulative number of use commands.
    - "cmd-watch" is the cumulative number of watch commands.
    - "cmd-ignore" is the cumulative number of ignore commands.
    - "cmd-delete" is the cumulative number of delete commands.
    - "cmd-release" is the cumulative number of release commands.
    - "cmd-bury" is the cumulative number of bury commands.
    - "cmd-kick" is the cumulative number of kick commands.
    - "cmd-stats" is the cumulative number of stats commands.
    - "cmd-stats-job" is the cumulative number of stats-job commands.
    - "cmd-stats-tube" is the cumulative number of stats-tube commands.
    - "cmd-list-tubes" is the cumulative number of list-tubes commands.
    - "cmd-list-tube-used" is the cumulative number of list-tube-used commands.
    - "cmd-list-tubes-watched" is the cumulative number of list-tubes-watched commands.
    - "job-timeouts" is the cumulative count of times a job has timed out.
    - "total-jobs" is the cumulative count of jobs created.
    - "max-job-size" is the maximum number of bytes in a job.
    - "current-tubes" is the number of currently-existing tubes.
    - "current-connections" is the number of currently open connections.
    - "current-producers" is the number of open connections that have each issued at least one put command.
    - "current-workers" is the number of open connections that have each issued at least one reserve command.
    - "current-waiting" is the number of open connections that have issued a reserve command but not yet received a response.
    - "total-connections" is the cumulative count of connections.
    - "pid" is the process id of the server.
    - "version" is the version string of the server.
    - "rusage-utime" is the accumulated user CPU time of this process in seconds and microseconds.
    - "rusage-stime" is the accumulated system CPU time of this process in seconds and microseconds.
    - "uptime" is the number of seconds since this server started running.
    - "binlog-oldest-index" is the index of the oldest binlog file needed to store the current jobs
    - "binlog-current-index" is the index of the current binlog file being written to. If binlog is not active this value will be 0
    - "binlog-max-size" is the maximum size in bytes a binlog file is allowed to get before a new binlog file is opened
    
    返回:
  - listTubes
```
List<String> listTubes()
```
    The list-tubes command returns a list of all existing tubes.
    
    返回:
  - listTubeUsed
```
String listTubeUsed()
```
    The list-tube-used command returns the tube currently being used by the client.
    
    返回:
    
    the name of the tube being used.
  - listTubeWatched
```
List<String> listTubeWatched()
```
    The list-tubes-watched command returns a list tubes currently being watched by the client.
    
    返回:
  - close
```
void close()
```
    close the current connection and release resources. that's status is closed, and is no longer available.
    
    指定者:
    
    close 在接口中 JobConsumer
    
    指定者:
    
    close 在接口中 JobProducer

接口 BeanstalkClient

方法概要

从接口继承的方法 com.dinstone.beanstalkc.JobConsumer

从接口继承的方法 com.dinstone.beanstalkc.JobProducer

方法详细资料

useTube

ignoreTube

watchTube

kick

peek

peekReady

peekDelayed

peekBuried

statsJob

statsTube

stats

listTubes

listTubeUsed

listTubeWatched

close