JsDoc: KeySequence

Class KeySequence

Defined in KeySequence.js

Constructor Summary
`KeySequence(length)` Implements a key sequence as described by XEP-0124, section 15.

Method Summary
	`_createNewSeed()` Return a seed to use for generating a new sequence of keys.
	`_hash(value)` Used to hash the value of each key.
	`_initKeys(length)` Initialize a list of keys to use for requests.
`String`	`getNextKey()` Get the next key in the sequence, or throw an error if there are none left (since keys are pre-generated).
	`getSize()` Get the size of the key sequence.
	`isFirstKey()` Returns true if this is the first key in a new sequence.
	`isLastKey()` Returns true if this is the last key in the sequence.
	`reset()` undocumented

Constructor Detail

KeySequence

KeySequence(length)

Implements a key sequence as described by XEP-0124, section 15.

Parameters:

length

Method Detail

_createNewSeed

_createNewSeed()

Return a seed to use for generating a new sequence of keys. Currently implemented to use Math.random().

_hash

_hash(value)

Used to hash the value of each key. Spec says it must be sha1-hex, so that's what it used.

Parameters:

value

_initKeys

_initKeys(length)

Initialize a list of keys to use for requests.

Parameters:

length

getNextKey

String getNextKey()

Get the next key in the sequence, or throw an error if there are none left (since keys are pre-generated).

Returns:

String

getSize

getSize()

Get the size of the key sequence.

isFirstKey

isFirstKey()

Returns true if this is the first key in a new sequence.

isLastKey

isLastKey()

Returns true if this is the last key in the sequence. A new sequence will need to be generated. This is the responsibility of the user of the class at this point.

reset

reset()

undocumented

Documentation generated by JsDoc Toolkit 1.4.1 on Tue Aug 26 2008 14:35:54 GMT-0500 (CDT)