<commit_before>Reacto-KinesiX
=======================

A [Rx](https://rx.codeplex.com/)-based .Net client library for [Amazon Kinesis](http://aws.amazon.com/kinesis/).

This guide contains the following sections:
1. [The Basics](#the-basics) - how to get started using this library
2. [Features](#features) - what you can expect from this library
3. [Error Handling](#error-handling) - what happens when things go wrong
4. [Distributed Processing](#distributed-processing) - what happens when you scale out your processing capability





## The Basics

#### Before you start

Please familiarize yourself with how **Amazon Kinesis** works by looking through its online [documentations](http://aws.amazon.com/documentation/kinesis/), in particular its [Key Concepts](http://docs.aws.amazon.com/kinesis/latest/dev/key-concepts.html) and [Limitations](http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html).


#### Getting Started

This library enables you to create a client application which consumes and processes records that have been pushed to an *Amazon Kinesis* **stream** by taking care of most of the plumbing involved.

To process incoming records, you need to provide an implementation for the `IRecordProcessor` interface which has the following methods:

<table>
	<tbody>
		<tr>
			<td><strong>Process</strong></td>
			<td><p>Process a <i>record</i> received from the <i>Stream</i>.</p></td>
		</tr>
		<tr>
			<td><strong>GetErrorHandlingMode</strong></td>
			<td><p>If the processor failed to processor a record due to unhanded exception, this method will be invoked to give you the chance to decide how the error should be handled. 
				</p>There are two available error handling modes:</p>
				<ul>
					<li>Retry n times and then <strong>skip</strong> to the next record</li>
					<li>Retry n times and then <strong>stop</strong> processing further records from this <i>shard</i></li><commit_msg>- updated README<commit_after>Reacto-KinesiX
=======================

A [Rx](https://rx.codeplex.com/)-based .Net client library for [Amazon Kinesis](http://aws.amazon.com/kinesis/).

This guide contains the following sections:
- [The Basics](#the-basics) - how to get started using this library
- [Features](#features) - what you can expect from this library
- [Error Handling](#error-handling) - what happens when things go wrong
- [Distributed Processing](#distributed-processing) - what happens when you scale out your processing capability





## The Basics

#### Before you start

Please familiarize yourself with how **Amazon Kinesis** works by looking through its online [documentations](http://aws.amazon.com/documentation/kinesis/), in particular its [Key Concepts](http://docs.aws.amazon.com/kinesis/latest/dev/key-concepts.html) and [Limitations](http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html).


#### Getting Started

This library enables you to create a client application which consumes and processes records that have been pushed to an *Amazon Kinesis* **stream** by taking care of most of the plumbing involved.

To process incoming records, you need to provide an implementation for the `IRecordProcessor` interface which has the following methods:

<table>
	<tbody>
		<tr>
			<td><strong>Process</strong></td>
			<td><p>Process a <i>record</i> received from the <i>Stream</i>.</p></td>
		</tr>
		<tr>
			<td><strong>GetErrorHandlingMode</strong></td>
			<td><p>If the processor failed to processor a record due to unhanded exception, this method will be invoked to give you the chance to decide how the error should be handled. 
				</p>There are two available error handling modes:</p>
				<ul>
					<li>Retry n times and then <strong>skip</strong> to the next record</li>
					<li>Retry n times and then <strong>stop</strong> processing further records from this <i>shard</i></li>
{'fraction_non_alphanumeric': 0.12858990944372575, 'fraction_numerical': 0.001034928848641656, 'mean_word_length': 4.586705202312139, 'pattern_counts': {'":': 0, '<': 75, '<?xml version=': 0, '>': 75, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1384427', 'n_tokens_mistral': 1173, 'n_tokens_neox': 1089, 'n_words': 413}