浏览代码

Add docs for ConsumerConfig#Validate.

Willem van Bergen 11 年之前
父节点
当前提交
9d9be45ad0
共有 1 个文件被更改,包括 4 次插入0 次删除
  1. 4 0
      consumer.go

+ 4 - 0
consumer.go

@@ -320,6 +320,10 @@ func (c *Consumer) getOffset(where OffsetTime, retry bool) (int64, error) {
 	return -1, block.Err
 }
 
+// Valides a ConsumerConfig instance. This will change zero
+// values into sensible defaults if possible, and it will return a
+// ConfigurationError if the specified value doesn't make sense and
+// cannot be corrected.
 func (config *ConsumerConfig) Validate() error {
 	if config.DefaultFetchSize < 0 {
 		return ConfigurationError("Invalid DefaultFetchSize")