Skip to content
This repository has been archived by the owner on Nov 20, 2018. It is now read-only.

Add doc comments for FormOptions. #621

Merged
merged 1 commit into from
Apr 29, 2016
Merged

Add doc comments for FormOptions. #621

merged 1 commit into from
Apr 29, 2016

Conversation

Tratcher
Copy link
Member

@Tratcher Tratcher self-assigned this Apr 28, 2016
@Tratcher Tratcher added this to the 1.0.0 milestone Apr 28, 2016
public long BufferBodyLengthLimit { get; set; } = DefaultBufferBodyLengthLimit;

/// <summary>
/// A limit for the number of form entries to allow. Entries with the same key will be combine.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: combined

@muratg
Copy link

muratg commented Apr 28, 2016

Address the comments, and :shipit:


/// <summary>
/// If <see cref="BufferBody"/> is enabled, this is the limit for the total number of bytes that will
/// be buffered. Forms that exceed this limit will throw an <see cref="InvalidDataException"/> when parsed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curious regarding usage of MemoryBufferThreshold vs. BufferBodyLengthLimit: If I want to buffer the data and also be safe from larger payloads, I could set the MemoryBufferThreshold alone...so wondering the use of BufferBodyLengthLimit

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MemoryBufferThreshold is not a hard limit, no exceptions will be thrown. It's just the amount of memory to use before switching to disk instead.

@kichalla
Copy link
Member

:shipit: Thanks, the comments cleared some questions for me!.

public int KeyLengthLimit { get; set; } = FormReader.DefaultKeyLengthLimit;

/// <summary>
/// A limit on the length of individual form values. Forms that exceed this limit will throw
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a individual form entry value exceeds this limit then whatever will throw.

@Tratcher Tratcher merged commit 7ebd87a into dev Apr 29, 2016
@Tratcher Tratcher deleted the tratcher/formdocs branch April 29, 2016 17:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants