# Class: RecordParser

## vertx-js/record_parser~ RecordParser

#### new RecordParser()

A helper class which allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed size records.

Source:
  - vertx-js/record_parser.js, line 32

### Methods

#### delimitedMode(delim)

Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter `delim`.

This method can be called multiple times with different values of delim while data is being parsed.

##### Parameters:

Name | Type | Description
--- | --- | ---
`delim` | Buffer | the new delimiter

Source:
  - vertx-js/record_parser.js, line 61

#### endHandler(endHandler) → {RecordParser}

##### Parameters:

Name | Type | Description
--- | --- | ---
`endHandler` | function |

Source:
  - vertx-js/record_parser.js, line 182

##### Returns:

Type
  RecordParser

#### exceptionHandler(handler) → {RecordParser}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/record_parser.js, line 122

##### Returns:

Type
  RecordParser

#### fixedSizeMode(size)

Flip the parser into fixed size mode, where the record size is specified by `size` in bytes.

This method can be called multiple times with different values of size while data is being parsed.

##### Parameters:

Name | Type | Description
--- | --- | ---
`size` | number | the new record size

Source:
  - vertx-js/record_parser.js, line 78

#### handle(buffer)

This method is called to provide the parser with data.

##### Parameters:

Name | Type | Description
--- | --- | ---
`buffer` | Buffer | a chunk of data

Source:
  - vertx-js/record_parser.js, line 109

#### handler(handler) → {RecordParser}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/record_parser.js, line 138

##### Returns:

Type
  RecordParser

#### maxRecordSize(size) → {RecordParser}

Set the maximum allowed size for a record when using the delimited mode. The delimiter itself does not count for the record size.

If a record is longer than specified, an IllegalStateException will be thrown.

##### Parameters:

Name | Type | Description
--- | --- | ---
`size` | number | the maximum record size

Source:
  - vertx-js/record_parser.js, line 95

##### Returns:

a reference to this, so the API can be used fluently

Type
  RecordParser

#### pause() → {RecordParser}

Source:
  - vertx-js/record_parser.js, line 154

##### Returns:

Type
  RecordParser

#### resume() → {RecordParser}

Source:
  - vertx-js/record_parser.js, line 168

##### Returns:

Type
  RecordParser

#### setOutput(output)

##### Parameters:

Name | Type | Description
--- | --- | ---
`output` | function |

Source:
  - vertx-js/record_parser.js, line 43