TopSdk TOP上传请求接口，支持同时上传多个文件。 获取所有的Key-Value形式的文件请求参数字典。其中： Key: 请求参数名 Value: 文件对象 文件请求参数字典 异地多活自动分配集群客户端。 日志打点的简单实现。 符合TOP习惯的纯字符串字典结构。 添加一个新的键值对。空键或者空值的键值对将会被忽略。 键名称 键对应的值，目前支持：string, int, long, double, bool, DateTime类型 TOP客户端。 执行TOP公开API请求。 领域对象 具体的TOP API请求 领域对象 执行TOP隐私API请求。 领域对象 具体的TOP API请求 用户会话码 领域对象 执行TOP隐私API请求。 领域对象 具体的TOP API请求 用户会话码 请求时间戳 领域对象 批量API请求包装类。 公共方法 公共参数 基于REST的TOP客户端。 创建基于REST的TOP客户端。 服务地址 应用key：管理中心 -> 应用列表 -> 应用详情中 应用key：管理中心 -> 应用列表 -> 应用详情中 创建基于REST的TOP客户端。 服务地址 应用key：管理中心 -> 应用列表 -> 应用详情中 应用key：管理中心 -> 应用列表 -> 应用详情中 请求返回格式类型 设置超时时间 设置读写超时时间 批量API响应类。 当批量API请求成功后，或获取所有API的响应结果。 根据指定的API请求获取相应的API响应结果。 基础TOP请求类，存放一些通用的请求参数。 HTTP请求URL参数 HTTP请求头参数 请求目标AppKey 批量API请求的用户授权码 API在批量调用中的顺序 基础对象。 判断是否密文数据 加密字段类型(例如：nick\phone) 判断是否密文数据 加密手机尾号后8位 加密手机后4位转H-MAC 手机号后4位H-MAC值 生成密文数据 滑窗加密 密文检索 获取秘钥版本、加密原始数据 获取秘钥版本、加密原始数据（支持密文检索） 伪随机码 秘钥版本 自主账号id 计数器 秘钥值 秘钥版本号 下次更新秘钥间隔，单位（秒） 最长有效期，容灾使用，单位（秒） App配置信息 加、解密客户端(单例使用，不要初始化多个) 秘钥管理核心类 serverUrl必须是https协议 伪随机码 初始化秘钥（如果半小时内会调用加、解密方法，建议先初始化秘钥）。所有用户共用秘钥 初始化秘钥（如果半小时内会调用加、解密方法，建议先初始化秘钥）。每个用户单独分配秘钥 批量解密（所有用户共用秘钥） 批量解密（每个用户单独分配秘钥） key=密文数据，value=明文数据 解密（所有用户共用秘钥） 解密（每个用户单独分配秘钥） 密文数据 手机号码格式：$手机号码前3位明文$base64(encrypt(phone后8位))$111$ nick格式：~base64(encrypt(nick))~111~ 解密字段类型(例如：nick\phone) 用户身份,用户级加密必填 判断list元素是否全部为密文数据 加密字段类型(例如：nick\phone) 判断是否密文数据 加密字段类型(例如：nick\phone) 加密（所有用户共用秘钥） 用老秘钥加密，只在秘钥升级时使用（所有用户共用秘钥） 加密（每个用户单独分配秘钥） 用老秘钥加密，只在秘钥升级时使用（每个用户单独分配秘钥） 密文检索（所有用户共用秘钥） 密文检索,在秘钥升级场景下兼容查询（所有用户共用秘钥） 密文检索（每个用户单独分配秘钥） 密文检索,在秘钥升级场景下兼容查询（每个用户单独分配秘钥） 密文检索。 手机号码格式：$base64(H-MAC(phone后4位))$ nick格式：base64(H-MAC(滑窗)) 明文数据 加密字段类型(例如：nick\phone) 用户身份,用户级加密必填 秘钥历史版本 加密之后格式。 手机号码格式：$手机号码前3位明文$base64(encrypt(phone后8位))$111$ nick格式：~base64(encrypt(nick))~111~ 明文数据 加密字段类型(例如：nick\phone) 用户身份,用户级加密必填 秘钥历史版本 批量加密（所有用户共用秘钥） 批量加密（每个用户单独分配秘钥） key=明文数据，value=密文数据 生成自定义session，提供给自主账号使用 明文、h_mac数据 原始base64加密之后的密文数据 秘钥版本 搜索 秘钥 秘钥版本 过期时间，单位（毫秒） 最长有效期，单位（毫秒） 判断是否过期 容灾，调用api获取秘钥可能会失败，在失败情况下最长有效期 加、解密核心类 判断密文是否支持检索 获取压缩长度 获取滑动窗口大小 获取秘钥 从本地获取秘钥信息 调用获取秘钥api 设置空缓存 异步更新秘钥 错误码 错误信息 子错误码 子错误信息 响应原始内容 响应结果是否错误 控制回传间隔，单位（毫秒） 安全工具类 判断是否base64值 生成滑动窗口 数据 分词大小 分词元素 判断是否小写字母 压缩 Base64加密 待加密的明文 编码方式 Base64加密 待加密的明文 参看SecurityUtil.EncodeBase64(string,Encoding)方法的说明 AES加密 待加密的内容 加密密钥 AES解密 生成BASE64(H_MAC) 被签名的字符串 秘钥 生成BASE64(H_MAC),压缩H_MAC值 SPI请求校验结果。 SPI服务提供方工具类。 校验SPI请求签名，不支持带上传文件的HTTP请求。 HttpRequest对象实例 APP密钥 校验结果 校验SPI请求签名，适用于Content-Type为application/x-www-form-urlencoded或multipart/form-data的GET或POST请求。 请求对象 app对应的secret true：校验通过；false：校验不通过 校验SPI请求签名，适用于Content-Type为text/xml或text/json的POST请求。 请求对象 请求体的文本内容 app对应的secret true：校验通过；false：校验不通过 签名规则：hex(md5(secret+sorted(header_params+url_params+form_params)+body)+secret) 检查SPI请求到达服务器端是否已经超过指定的分钟数，如果超过则拒绝请求。 true代表不超过，false代表超过。 检查发起SPI请求的来源IP是否是TOP机房的出口IP。 HTTP请求对象 TOP网关IP出口地址段列表，通过taobao.top.ipout.get获得 true表达IP来源合法，false代表IP来源不合法 文件元数据。 可以使用以下几种构造方法： 本地路径：new FileItem("C:/temp.jpg"); 本地文件：new FileItem(new FileInfo("C:/temp.jpg")); 字节数组：new FileItem("abc.jpg", bytes); 输入流：new FileItem("abc.jpg", stream); 基于本地文件的构造器。 本地文件 基于本地文件全路径的构造器。 本地文件全路径 基于文件名和字节数组的构造器。 文件名称（服务端持久化字节数组到磁盘时的文件名） 文件字节数组 基于文件名、字节数组和媒体类型的构造器。 文件名（服务端持久化字节数组到磁盘时的文件名） 文件字字节数组 媒体类型 基于文件名和输入流的构造器。 文件名称（服务端持久化输入流到磁盘时的文件名） 文件输入流 基于文件名、输入流和媒体类型的构造器。 文件名（服务端持久化输入流到磁盘时的文件名） 文件输入流 媒体类型 网络工具类。 等待请求开始返回的超时时间 等待读取数据完成的超时时间 是否忽略SSL检查 执行HTTP POST请求。 请求地址 请求文本参数 HTTP响应 执行HTTP POST请求。 请求地址 请求文本参数 请求头部参数 HTTP响应 执行HTTP GET请求。 请求地址 请求文本参数 HTTP响应 执行HTTP GET请求。 请求地址 请求文本参数 请求头部参数 HTTP响应 执行带文件上传的HTTP POST请求。 请求地址 请求文本参数 请求文件参数 请求头部参数 HTTP响应 执行带body体的POST请求。 请求地址，含URL参数 请求body体字节流 body内容类型 请求头部参数 HTTP响应 把响应流转换为文本。 响应流对象 编码方式 响应文本 组装含参数的请求URL。 请求地址 请求参数映射 带参数的请求URL 组装含参数的请求URL。 请求地址 一个或多个经过URL编码后的请求参数串 带参数的请求URL 组装普通文本请求参数。 Key-Value形式请求参数字典 URL编码后的请求数据 异步API下载工具类。 通过HTTP GET方式下载文件到指定的目录。 需要下载的URL 需要下载到的目录 下载后的文件 解压gzip文件到指定的目录，目前只能解压gzip包里面只包含一个文件的压缩包。 需要解压的gzip文件 需要解压到的目录（不能和压缩文件在同一个目录） 解压后的文件 解压zip文件到指定的目录。 需要解压的zip文件 需要解压到的目录 解压后的文件列表（不包含文件夹） 检查指定文件的md5sum和指定的检验码是否一致。 需要检验的文件 已知的md5sum检验码 true/false TOP系统工具类。 给TOP请求签名。 所有字符型的TOP请求参数 签名密钥 签名方法，可选值：md5, hmac 签名 给TOP请求签名。 所有字符型的TOP请求参数 请求主体内容 签名密钥 签名方法，可选值：md5, hmac 签名 清除字典中值为空的项。 待清除的字典 清除后的字典 把对象转换为JSON字符串。 把JSON字符串转换为对象。 把JSON解释为API响应对象。 API响应类型 JSON字符串 API响应对象 获取从1970年1月1日到现在的毫秒总数。 毫秒数 获取本机的局域网IP。 请求验证器。 验证参数是否为空。 参数名 参数值 验证字符串参数的最大长度。 参数名 参数值 最大长度 验证上传文件的最大字节长度。 参数名 参数值 最大长度 验证以逗号分隔的字符串参数的最大列表长度。 参数名 参数值 最大列表长度 验证复杂结构数组参数的最大列表长度。 参数名 参数值 最大列表长度 验证字符串参数的最小长度。 参数名 参数值 最小长度 验证数字参数的最大值。 参数名 参数值 最大值 验证数字参数的最小值。 参数名 参数值 最小值 奇门XML响应通用解释器。 TOP JSON响应通用读取器。 TOP XML响应通用解释器。 获取XML响应的根节点名称 TOP JSON响应通用解释器。 TOP API响应解释器接口。响应格式可以是XML, JSON等等。 把响应字符串解释成相应的领域对象。 领域对象 响应字符串 领域对象 把响应字符串解释成相应的领域对象。 响应字符串 领域对象 领域对象 TOP API响应读取器接口。响应格式可以是XML, JSON等等。 判断响应中是否包含指定的属性。 属性名称 true/false 获取值类型属性的值。 属性名称 值对象 获取引用类型的值。 属性名称 引用类型 转换器 引用对象 获取列表类型的值。 列表属性名称 列表项名称 引用类型 转换器 列表对象 TOP请求接口。 获取TOP的API名称。 获取被调用的目标AppKey 获取所有的Key-Value形式的文本请求参数字典。 获取自定义HTTP请求头参数。 获取API请求的用户授权码，仅用于批量API调用请求。 设置API请求的用户授权码，仅用于批量API调用请求。 获取API在批量调用中的顺序，仅用于批量API调用请求。 设置API在批量调用中的顺序，仅用于批量API调用请求。 客户端参数检查，减少服务端无效调用。 调用出错自动重试客户端。 单次请求的最大重试次数，默认值为3次。 重试之前休眠时间，默认值为100毫秒。 超过最大重试次数时是否抛出异常。 自定义重试错误码列表。 日志打点接口。 TOP客户端异常。 BizResult Data Structure. code 错误码 返回结果 返回信息描述 true表示成功，false表示失败 Subtask Data Structure. 标记子任务是否成功。为true表示子任务成功，用户可以按照正确执行的结果格式解析sub_task_result。为false表示子任务失败了，用户需要按照失败的结果格式解析sub_task_result（里面只有sub_code和sub_msg） 子任务的有效请求参数，以json格式进行key:value的组合 子任务返回的结果，以json格式进行key:value组合，可以和单个api请求结果解析复用。以获取交易订单详情为例：子任务执行成功返回的结果格式为：{“trade”:{"tid":123456,"seller_nick":"淘宝卖家"}}；子任务执行失败结果格式为{"sub_code":"isv.trade-not-exist","sub_msg":"交易订单不存在"} Area Data Structure. 标准行政区域代码.参考:http://www.stats.gov.cn/tjbz/xzqhdm/t20120105_402777427.htm 地域名称.如北京市,杭州市,西湖区,每一个area_id 都代表了一个具体的地区. 父节点区域标识.如北京市的area_id是110100,朝阳区是北京市的一个区,所以朝阳区的parent_id就是北京市的area_id. 区域类型.area区域 1:country/国家;2:province/省/自治区/直辖市;3:city/地区(省下面的地级市);4:district/县/市(县级市)/区;abroad:海外. 比如北京市的area_type = 2,朝阳区是北京市的一个区,所以朝阳区的area_type = 4. 具体一个地区的邮编 Task Data Structure. 下载文件的MD5校验码，通过此校验码可以检查下载的文件是否是完整的。 任务创建时间 大任务结果下载地址。当创建的认任务是大数据量的任务时，获取结果会返回此字段，同时subtasks列表会为空。 通过这个地址可以下载到结果的结构体，格式同普通任务下载的一样。 每次获取到的地址只能下载一次。下载的文件加上后缀名.zip打开。 此任务是由哪个api产生的 定时类型任务的执行时间点 异步任务处理状态。new（还未开始处理），doing（处理中），done（处理结束）。 子任务处理结果，如果任务还没有处理完，返回的结果列表为空。如果任务处理完毕，返回子任务结果列表 异步任务id。创建异步任务时返回的任务id号 KfcSearchResult Data Structure. 过滤后的文本： 当匹配到B等级的词时，文本中的关键词被替换为*号，content即为关键词替换后的文本； 其他情况，content始终为null 匹配到的关键词的等级，值为null，或为A、B、C、D。 当匹配不到关键词时，值为null，否则值为A、B、C、D中的一个。 A、B、C、D等级按严重程度从高至低排列。 是否匹配到关键词,匹配到则为true. TOP API: taobao.top.secret.register 用户id，保证唯一 TOP API: alibaba.aliqin.fc.iot.rechargeCard IMEI号 外部计费号类型：写‘IMEI’ 生效时间,1,立即生效; 2,次月生效 ICCID 流量包offerId 外部id,用来做幂等 TOP API: taobao.kfc.keyword.search 应用点，分为一级应用点、二级应用点。其中一级应用点通常是指某一个系统或产品，比如淘宝的商品应用（taobao_auction）；二级应用点，是指一级应用点下的具体的分类，比如商品标题(title)、商品描述(content)。不同的二级应用可以设置不同关键词。 这里的apply参数是由一级应用点与二级应用点合起来的字符（一级应用点+"."+二级应用点），如taobao_auction.title。 通常apply参数是不需要传递的。如有特殊需求（比如特殊的过滤需求，需要自己维护一套自己词库），需传递此参数。 需要过滤的文本信息 发布信息的淘宝会员名，可以不传 TOP API: alibaba.aliqin.fc.tts.num.singlecall 被叫号码，支持国内手机号与固话号码,格式如下057188773344,13911112222,4001112222,95500 被叫号显，传入的显示号码必须是阿里大于“管理中心-号码管理”中申请或购买的号码 公共回传参数，在“消息返回”中会透传回该参数；举例：用户可以传入自己下级的会员ID，在消息返回时，该会员ID会包含在内，用户可以根据该会员ID识别是哪位会员使用了你的应用 TTS模板ID，传入的模板必须是在阿里大于“管理中心-语音TTS模板管理”中的可用模板 文本转语音（TTS）模板变量，传参规则{"key"："value"}，key的名字须和TTS模板中的变量名一致，多个变量之间以逗号隔开，示例：{"name":"xiaoming","code":"1234"} TOP API: alibaba.aliqin.fc.voice.num.singlecall 被叫号码，支持国内手机号与固话号码,格式如下057188773344,13911112222,4001112222,95500 被叫号显，传入的显示号码必须是阿里大于“管理中心-号码管理”中申请通过的号码 公共回传参数，在“消息返回”中会透传回该参数；举例：用户可以传入自己下级的会员ID，在消息返回时，该会员ID会包含在内，用户可以根据该会员ID识别是哪位会员使用了你的应用 语音文件ID，传入的语音文件必须是在阿里大于“管理中心-语音文件管理”中的可用语音文件 TOP API: alibaba.aliqin.fc.flow.charge.province 需要充值的流量 唯一流水号 手机号 充值原因 TOP API: alibaba.aliqin.fc.voice.num.doublecall 被叫号码，支持国内手机号与固话号码,格式如下057188773344,13911112222,4001112222,95500 被叫号码侧的号码显示，传入的显示号码可以是阿里大于“管理中心-号码管理”中申请通过的号码。显示号码格式如下057188773344，4001112222，95500。显示号码也可以为主叫号码。 主叫号码，支持国内手机号与固话号码,格式如下057188773344,13911112222,4001112222,95500 主叫号码侧的号码显示，传入的显示号码必须是阿里大于“管理中心-号码管理”中申请通过的号码。显示号码格式如下057188773344，4001112222，95500 公共回传参数，在“消息返回”中会透传回该参数；举例：用户可以传入自己下级的会员ID，在消息返回时，该会员ID会包含在内，用户可以根据该会员ID识别是哪位会员使用了你的应用 通话超时时长，如接通后到达120秒时，通话会因为超时自动挂断。若无需设置超时时长，可不传。 TOP API: taobao.top.ipout.get TOP API: taobao.top.auth.token.refresh grantType==refresh_token 时需要 TOP API: taobao.topats.task.delete 需要取消的任务ID TOP API: alibaba.aliqin.fc.sms.num.send 公共回传参数，在“消息返回”中会透传回该参数；举例：用户可以传入自己下级的会员ID，在消息返回时，该会员ID会包含在内，用户可以根据该会员ID识别是哪位会员使用了你的应用 短信接收号码。支持单个或多个手机号码，传入号码为11位手机号码，不能加0或+86。群发短信需传入多个号码，以英文逗号分隔，一次调用最多传入200个号码。示例：18600000000,13911111111,13322222222 短信签名，传入的短信签名必须是在阿里大于“管理中心-短信签名管理”中的可用签名。如“阿里大于”已在短信签名管理中通过审核，则可传入”阿里大于“（传参时去掉引号）作为短信签名。短信效果示例：【阿里大于】欢迎使用阿里大于服务。 短信模板变量，传参规则{"key":"value"}，key的名字须和申请模板中的变量名一致，多个变量之间以逗号隔开。示例：针对模板“验证码${code}，您正在进行${product}身份验证，打死不要告诉别人哦！”，传参时需传入{"code":"1234","product":"alidayu"} 短信模板ID，传入的模板必须是在阿里大于“管理中心-短信模板管理”中的可用模板。示例：SMS_585014 短信类型，传入值请填写normal TOP API: taobao.top.auth.token.create 授权code，grantType==authorization_code 时需要 与生成code的uuid配对 TOP API: taobao.top.sdk.feedback.upload 具体内容，json形式 1、回传加密信息 TOP API: alibaba.aliqin.fc.sms.num.query 短信发送流水 分页参数,页码 分页参数，每页数量。最大值50 短信发送日期，支持近30天记录查询，格式yyyyMMdd 短信接收号码 TOP API: alibaba.aliqin.fc.flow.charge 需要充值的流量 唯一流水号 手机号 充值原因 TOP API: taobao.appip.get TOP API: alibaba.aliqin.fc.flow.query 唯一流水号 TOP API: alibaba.aliqin.fc.flow.grade TOP API: taobao.top.secret.get 自定义用户id 伪随机数 秘钥版本号 TOP API: taobao.httpdns.get TOP API: taobao.topats.result.get 任务ID，创建任务时返回的task_id TOP API: taobao.areas.get 需返回的字段列表.可选值:Area 结构中的所有字段;多个字段之间用","分隔.如:id,type,name,parent_id,zip. TOP API: alibaba.aliqin.fc.iot.qrycard 外部计费号 外部计费来源 ICCID TOP API: taobao.time.get TopSecretRegisterResponse. 返回操作是否成功 AlibabaAliqinFcIotRechargeCardResponse. result ResultDomain Data Structure. code model msg success KfcKeywordSearchResponse. KFC 关键词过滤匹配结果 AlibabaAliqinFcTtsNumSinglecallResponse. 接口返回参数 AlibabaAliqinFcVoiceNumSinglecallResponse. 返回值 AlibabaAliqinFcFlowChargeProvinceResponse. 无 ResultDomain Data Structure. 错误码 无 原因 结果 AlibabaAliqinFcVoiceNumDoublecallResponse. 接口返回参数 TopIpoutGetResponse. TOP网关出口IP列表 TopAuthTokenRefreshResponse. 返回的是json信息 TopatsTaskDeleteResponse. 表示操作是否成功，是为true，否为false。 AlibabaAliqinFcSmsNumSendResponse. 返回值 TopAuthTokenCreateResponse. 返回的是json信息，和之前调用https://oauth.taobao.com/tac/token https://oauth.alibaba.com/token 换token返回的字段信息一致 TopSdkFeedbackUploadResponse. 控制回传间隔（单位：秒） AlibabaAliqinFcSmsNumQueryResponse. 当前页码 每页数量 总量 总页数 1 FcPartnerSmsDetailDtoDomain Data Structure. 公共回传参数 短信接收号码 短信错误码 模板编码 短信发送内容 短信接收时间 短信发送时间 发送状态 1：等待回执，2：发送失败，3：发送成功 AlibabaAliqinFcFlowChargeResponse. 返回值 ResultDomain Data Structure. 错误码 无 原因 true成功，false失败 AppipGetResponse. ISV发起请求服务器IP AlibabaAliqinFcFlowQueryResponse. 无 ResultDomain Data Structure. 错误码 id：提交的唯一流水号, time:提交时间, phone:充值号码, error:false成功，true失败, reason:错误原因, status:1充值中，3成功，4失败, flow:流量, operator:运营商 原因 状态 AlibabaAliqinFcFlowGradeResponse. 无 ResultDomain Data Structure. 错误码 档位 错误原因 状态 TopSecretGetResponse. app配置信息 下次更新秘钥间隔，单位（秒） 最长有效期，容灾使用，单位（秒） 秘钥值 秘钥版本号 HttpdnsGetResponse. HTTP DNS配置信息 TopatsResultGetResponse. 任务结果信息 AreasGetResponse. 地址区域信息列表.返回的Area包含的具体信息为入参fields请求的字段信息. AlibabaAliqinFcIotQrycardResponse. 系统自动生成 ModelDomain Data Structure. flowResource resourceType restOfFlow ResultDomain Data Structure. code model 系统自动生成 true返回成功，false返回失败 TimeGetResponse. 淘宝系统当前时间。格式:yyyy-MM-dd HH:mm:ss 消息服务客户端标识 获取appKey 获取groupName TMC服务端标识 消息服务客户端 获取或设置Log 获取或设置定时发送拉取请求的周期（单位：秒） 获取或设置自动重连间隔（单位：秒） 以默认分组，初始化TMC客户端 初始化TMC客户端 连接到 TMC Server TMC server address, eg: ws://mc.api.taobao.com/ 向指定的主题发布一条与用户无关的消息。 主题名称 严格根据主题定义的消息内容（JSON/XML） 向指定的主题发布一条与用户相关的消息。 主题名称 严格根据主题定义的消息内容（JSON/XML） 用户授权码 向服务端发送消息拉取请求 确认消息 获取消息 将当前消息处理设置为失败，若该消息启用了重试，失败的消息将会再指定时间内重新发送 将当前消息处理设置为失败，若该消息启用了重试，失败的消息将会再指定时间内重新发送 指定失败原因 对当前消息进行确认 消息服务-通用消息结构。 消息标识 主题 发布者标识 发布时间 从服务器发送时间 消息所属的用户ID，若不是用户相关消息则为空 消息所属的用户昵称，若不是用户相关消息则为空 消息的业务具体内容（JSON结构） Computes Adler32 checksum for a stream of data. An Adler32 checksum is not as reliable as a CRC32 checksum, but a lot faster to compute. The specification for Adler32 may be found in RFC 1950. ZLIB Compressed Data Format Specification version 3.3) From that document: "ADLER32 (Adler-32 checksum) This contains a checksum value of the uncompressed data (excluding any dictionary data) computed according to Adler-32 algorithm. This algorithm is a 32-bit extension and improvement of the Fletcher algorithm, used in the ITU-T X.224 / ISO 8073 standard. Adler-32 is composed of two sums accumulated per byte: s1 is the sum of all bytes, s2 is the sum of all s1 values. Both sums are done modulo 65521. s1 is initialized to 1, s2 to zero. The Adler-32 checksum is stored as s2*65536 + s1 in most- significant-byte first (network) order." "8.2. The Adler-32 algorithm The Adler-32 algorithm is much faster than the CRC32 algorithm yet still provides an extremely low probability of undetected errors. The modulo on unsigned long accumulators can be delayed for 5552 bytes, so the modulo operation time is negligible. If the bytes are a, b, c, the second sum is 3a + 2b + c + 3, and so is position and order sensitive, unlike the first sum, which is just a checksum. That 65521 is prime is important to avoid a possible large class of two-byte errors that leave the check unchanged. (The Fletcher checksum uses 255, which is not prime and which also makes the Fletcher check insensitive to single byte changes 0 - 255.) The sum s1 is initialized to 1 instead of zero to make the length of the sequence part of s2, so that the length does not have to be checked separately. (Any sequence of zeroes has a Fletcher checksum of zero.)" largest prime smaller than 65536 Returns the Adler32 data checksum computed so far. Creates a new instance of the Adler32 class. The checksum starts off with a value of 1. Resets the Adler32 checksum to the initial value. Updates the checksum with a byte value. The data value to add. The high byte of the int is ignored. Updates the checksum with an array of bytes. The source of the data to update with. Updates the checksum with the bytes taken from the array. an array of bytes the start of the data used for this update the number of bytes to use for this update Generate a table for a byte-wise 32-bit CRC calculation on the polynomial: x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x+1. Polynomials over GF(2) are represented in binary, one bit per coefficient, with the lowest powers in the most significant bit. Then adding polynomials is just exclusive-or, and multiplying a polynomial by x is a right shift by one. If we call the above polynomial p, and represent a byte as the polynomial q, also with the lowest power in the most significant bit (so the byte 0xb1 is the polynomial x^7+x^3+x+1), then the CRC is (q*x^32) mod p, where a mod b means the remainder after dividing a by b. This calculation is done using the shift-register method of multiplying and taking the remainder. The register is initialized to zero, and for each incoming bit, x^32 is added mod p to the register if the bit is a one (where x^32 mod p is p+x^32 = x^26+...+1), and the register is multiplied mod p by x (which is shifting right by one and adding x^32 mod p if the bit shifted out is a one). We start with the highest power (least significant bit) of q and repeat for all eight bits of q. The table is simply the CRC of all possible eight bit values. This is all the information needed to generate CRC's on data a byte at a time for all combinations of CRC register values and incoming bytes. The crc data checksum so far. Returns the CRC32 data checksum computed so far. Resets the CRC32 data checksum as if no update was ever called. Updates the checksum with the int bval. the byte is taken as the lower 8 bits of value Updates the checksum with the bytes taken from the array. buffer an array of bytes Adds the byte array to the data checksum. The buffer which contains the data The offset in the buffer where the data starts The number of data bytes to update the CRC with. Bzip2 checksum algorithm Initialise a default instance of Reset the state of Crc. Get the current Crc value. Update the Crc value. data update is based on Update Crc based on a block of data The buffer containing data to update the crc with. Update Crc based on a portion of a block of data block of data index of first byte to use number of bytes to use Interface to compute a data checksum used by checked input/output streams. A data checksum can be updated by one byte or with a byte array. After each update the value of the current checksum can be returned by calling getValue. The complete checksum object can also be reset so it can be used again with new data. Returns the data checksum computed so far. Resets the data checksum as if no update was ever called. Adds one byte to the data checksum. the data value to add. The high byte of the int is ignored. Updates the data checksum with the bytes taken from the array. buffer an array of bytes Adds the byte array to the data checksum. The buffer which contains the data The offset in the buffer where the data starts the number of data bytes to add. SharpZipBaseException is the base exception class for the SharpZipLibrary. All library exceptions are derived from this. NOTE: Not all exceptions thrown will be derived from this class. A variety of other exceptions are possible for example Deserialization constructor for this constructor for this constructor Initializes a new instance of the SharpZipBaseException class. Initializes a new instance of the SharpZipBaseException class with a specified error message. A message describing the exception. Initializes a new instance of the SharpZipBaseException class with a specified error message and a reference to the inner exception that is the cause of this exception. A message describing the exception. The inner exception Determines how entries are tested to see if they should use Zip64 extensions or not. Zip64 will not be forced on entries during processing. An entry can have this overridden if required Zip64 should always be used. #ZipLib will determine use based on entry values when added to archive. The kind of compression used for an entry in an archive A direct copy of the file contents is held in the archive Common Zip compression method using a sliding dictionary of up to 32KB and secondary compression from Huffman/Shannon-Fano trees An extension to deflate with a 64KB window. Not supported by #Zip currently BZip2 compression. Not supported by #Zip. WinZip special for AES encryption, Now supported by #Zip. Identifies the encryption algorithm used for an entry No encryption has been used. Encrypted using PKZIP 2.0 or 'classic' encryption. DES encryption has been used. RCS encryption has been used for encryption. Triple DES encryption with 168 bit keys has been used for this entry. Triple DES with 112 bit keys has been used for this entry. AES 128 has been used for encryption. AES 192 has been used for encryption. AES 256 has been used for encryption. RC2 corrected has been used for encryption. Blowfish has been used for encryption. Twofish has been used for encryption. RC4 has been used for encryption. An unknown algorithm has been used for encryption. Defines the contents of the general bit flags field for an archive entry. Bit 0 if set indicates that the file is encrypted Bits 1 and 2 - Two bits defining the compression method (only for Method 6 Imploding and 8,9 Deflating) Bit 3 if set indicates a trailing data desciptor is appended to the entry data Bit 4 is reserved for use with method 8 for enhanced deflation Bit 5 if set indicates the file contains Pkzip compressed patched data. Requires version 2.7 or greater. Bit 6 if set indicates strong encryption has been used for this entry. Bit 7 is currently unused Bit 8 is currently unused Bit 9 is currently unused Bit 10 is currently unused Bit 11 if set indicates the filename and comment fields for this file must be encoded using UTF-8. Bit 12 is documented as being reserved by PKware for enhanced compression. Bit 13 if set indicates that values in the local header are masked to hide their actual values, and the central directory is encrypted. Used when encrypting the central directory contents. Bit 14 is documented as being reserved for use by PKware Bit 15 is documented as being reserved for use by PKware This class contains constants used for Zip format files The version made by field for entries in the central header when created by this library This is also the Zip version for the library when comparing against the version required to extract for an entry. See . The version made by field for entries in the central header when created by this library This is also the Zip version for the library when comparing against the version required to extract for an entry. See ZipInputStream.CanDecompressEntry. The minimum version required to support strong encryption The minimum version required to support strong encryption Version indicating AES encryption The version required for Zip64 extensions (4.5 or higher) Size of local entry header (excluding variable length fields at end) Size of local entry header (excluding variable length fields at end) Size of Zip64 data descriptor Size of data descriptor Size of data descriptor Size of central header entry (excluding variable fields) Size of central header entry Size of end of central record (excluding variable fields) Size of end of central record (excluding variable fields) Size of 'classic' cryptographic header stored before any entry data Size of cryptographic header stored before entry data Signature for local entry header Signature for local entry header Signature for spanning entry Signature for spanning entry Signature for temporary spanning entry Signature for temporary spanning entry Signature for data descriptor This is only used where the length, Crc, or compressed size isnt known when the entry is created and the output stream doesnt support seeking. The local entry cannot be 'patched' with the correct values in this case so the values are recorded after the data prefixed by this header, as well as in the central directory. Signature for data descriptor This is only used where the length, Crc, or compressed size isnt known when the entry is created and the output stream doesnt support seeking. The local entry cannot be 'patched' with the correct values in this case so the values are recorded after the data prefixed by this header, as well as in the central directory. Signature for central header Signature for central header Signature for Zip64 central file header Signature for Zip64 central file header Signature for Zip64 central directory locator Signature for archive extra data signature (were headers are encrypted). Central header digitial signature Central header digitial signature End of central directory record signature End of central directory record signature Default encoding used for string conversion. 0 gives the default system OEM code page. Dont use unicode encodings if you want to be Zip compatible! Using the default code page isnt the full solution neccessarily there are many variable factors, codepage 850 is often a good choice for European users, however be careful about compatability. Convert a portion of a byte array to a string. Data to convert to string Number of bytes to convert starting from index 0 data[0]..data[length - 1] converted to a string Convert a byte array to string Byte array to convert dataconverted to a string Convert a byte array to string The applicable general purpose bits flags Byte array to convert The number of bytes to convert. dataconverted to a string Convert a byte array to string Byte array to convert The applicable general purpose bits flags dataconverted to a string Convert a string to a byte array String to convert to an array Converted array Convert a string to a byte array The applicable general purpose bits flags String to convert to an array Converted array Initialise default instance of ZipConstants Private to prevent instances being created. Arguments used with KeysRequiredEvent Initialise a new instance of The name of the file for which keys are required. Initialise a new instance of The name of the file for which keys are required. The current key value. Gets the name of the file for which keys are required. Gets or sets the key value The strategy to apply to testing. Find the first error only. Find all possible errors. The operation in progress reported by a during testing. TestArchive Setting up testing. Testing an individual entries header Testing an individual entries data Testing an individual entry has completed. Running miscellaneous tests Testing is complete Status returned returned by during testing. TestArchive Initialise a new instance of The this status applies to. Get the current in progress. Get the this status is applicable to. Get the current/last entry tested. Get the number of errors detected so far. Get the number of bytes tested so far for the current entry. Get a value indicating wether the last entry test was valid. Delegate invoked during testing if supplied indicating current progress and status. If the message is non-null an error has occured. If the message is null the operation as found in status has started. The possible ways of applying updates to an archive. Perform all updates on temporary files ensuring that the original file is saved. Update the archive directly, which is faster but less safe. This class represents a Zip archive. You can ask for the contained entries, or get an input stream for a file entry. The entry is automatically decompressed. You can also update the archive adding or deleting entries. This class is thread safe for input: You can open input streams for arbitrary entries in different threads.

Author of the original java version : Jochen Hoenicke using System; using System.Text; using System.Collections; using System.IO; using ICSharpCode.SharpZipLib.Zip; class MainClass { static public void Main(string[] args) { using (ZipFile zFile = new ZipFile(args[0])) { Console.WriteLine("Listing of : " + zFile.Name); Console.WriteLine(""); Console.WriteLine("Raw Size Size Date Time Name"); Console.WriteLine("-------- -------- -------- ------ ---------"); foreach (ZipEntry e in zFile) { if ( e.IsFile ) { DateTime d = e.DateTime; Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize, d.ToString("dd-MM-yy"), d.ToString("HH:mm"), e.Name); } } } } } Delegate for handling keys/password setting during compresion/decompression. Event handler for handling encryption keys. Handles getting of encryption keys when required. The file for which encryption keys are required. Get/set the encryption key value. Password to be used for encrypting/decrypting files. Set to null if no password is required. Get a value indicating wether encryption keys are currently available. Opens a Zip file with the given name for reading. The name of the file to open. The argument supplied is null. An i/o error occurs The file doesn't contain a valid zip archive. Opens a Zip file reading the given . The to read archive data from. The supplied argument is null. An i/o error occurs. The file doesn't contain a valid zip archive. Opens a Zip file reading the given . The to read archive data from. An i/o error occurs The stream doesn't contain a valid zip archive.
 The stream doesnt support seeking. The stream argument is null. Initialises a default instance with no entries and no file storage. Finalize this instance. Closes the ZipFile. If the stream is owned then this also closes the underlying input stream. Once closed, no further instance methods should be called. An i/o error occurs. Create a new whose data will be stored in a file. The name of the archive to create. Returns the newly created is null Create a new whose data will be stored on a stream. The stream providing data storage. Returns the newly created is null doesnt support writing. Get/set a flag indicating if the underlying stream is owned by the ZipFile instance. If the flag is true then the stream will be closed when Close is called. The default value is true in all cases. Get a value indicating wether this archive is embedded in another file or not. Get a value indicating that this archive is a new one. Gets the comment for the zip file. Gets the name of this zip file. Gets the number of entries in this zip file. The Zip file has been closed. Get the number of entries contained in this . Indexer property for ZipEntries Gets an enumerator for the Zip entries in this Zip file. Returns an for this archive. The Zip file has been closed. Return the index of the entry with a matching name Entry name to find If true the comparison is case insensitive The index position of the matching entry or -1 if not found The Zip file has been closed. Searches for a zip entry in this archive with the given name. String comparisons are case insensitive The name to find. May contain directory components separated by slashes ('/'). A clone of the zip entry, or null if no entry with that name exists. The Zip file has been closed. Gets an input stream for reading the given zip entry data in an uncompressed form. Normally the should be an entry returned by GetEntry(). The to obtain a data for An input containing data for this The ZipFile has already been closed The compression method for the entry is unknown The entry is not found in the ZipFile Creates an input stream reading a zip entry The index of the entry to obtain an input stream for. An input containing data for this The ZipFile has already been closed The compression method for the entry is unknown The entry is not found in the ZipFile Test an archive for integrity/validity Perform low level data Crc check true if all tests pass, false otherwise Testing will terminate on the first error found. Test an archive for integrity/validity Perform low level data Crc check The to apply. The handler to call during testing. true if all tests pass, false otherwise The object has already been closed. Test a local header against that provided from the central directory The entry to test against The type of tests to carry out. The offset of the entries data in the file The kind of update to apply. Get / set the to apply to names when updating. Get/set the used to generate values during updates. Get /set the buffer size to be used when updating this zip file. Get a value indicating an update has been started. Get / set a value indicating how Zip64 Extension usage is determined when adding entries. Begin updating this archive. The archive storage for use during the update. The data source to utilise during updating. ZipFile has been closed. One of the arguments provided is null ZipFile has been closed. Begin updating to this archive. The storage to use during the update. Begin updating this archive. Commit current updates, updating this archive. ZipFile has been closed. Abort updating leaving the archive unchanged. Set the file comment to be recorded when the current update is commited. The comment to record. ZipFile has been closed. Add a new entry to the archive. The name of the file to add. The compression method to use. Ensure Unicode text is used for name and comment for this entry. Argument supplied is null. ZipFile has been closed. Compression method is not supported. Add a new entry to the archive. The name of the file to add. The compression method to use. ZipFile has been closed. The compression method is not supported. Add a file to the archive. The name of the file to add. Argument supplied is null. Add a file to the archive. The name of the file to add. The name to use for the on the Zip file created. Argument supplied is null. Add a file entry with data. The source of the data for this entry. The name to give to the entry. Add a file entry with data. The source of the data for this entry. The name to give to the entry. The compression method to use. Add a file entry with data. The source of the data for this entry. The name to give to the entry. The compression method to use. Ensure Unicode text is used for name and comments for this entry. Add a that contains no data. The entry to add. This can be used to add directories, volume labels, or empty file entries. Add a directory entry to the archive. The directory to add. Delete an entry by name The filename to delete True if the entry was found and deleted; false otherwise. Delete a from the archive. The entry to delete. Write an unsigned short in little endian byte order. Write an int in little endian byte order. Write an unsigned int in little endian byte order. Write a long in little endian byte order. Get a raw memory buffer. Returns a raw memory buffer. Get the size of the source descriptor for a . The update to get the size for. The descriptor size, zero if there isnt one. Get an output stream for the specified The entry to get an output stream for. The output stream obtained for the entry. Class used to sort updates. Compares two objects and returns a value indicating whether one is less than, equal to or greater than the other. First object to compare Second object to compare. Compare result. Represents a pending update to a Zip file. Copy an existing entry. The existing entry to copy. Get the for this update. This is the source or original entry. Get the that will be written to the updated/new file. Get the command for this update. Get the filename if any for this update. Null if none exists. Get/set the location of the size patch for this update. Get /set the location of the crc patch for this update. Get/set the size calculated by offset. Specifically, the difference between this and next entry's starting offset. Releases the unmanaged resources used by the this instance and optionally releases the managed resources. true to release both managed and unmanaged resources; false to release only unmanaged resources. Read an unsigned short in little endian byte order. Returns the value read. The stream ends prematurely Read a uint in little endian byte order. Returns the value read. An i/o error occurs. The file ends prematurely Search for and read the central directory of a zip file filling the entries array. An i/o error occurs. The central directory is malformed or cannot be found Locate the data for a given entry. The start offset of the data. The stream ends prematurely The local header signature is invalid, the entry and central header file name lengths are different or the local and entry compression methods dont match Represents a string from a which is stored as an array of bytes. Initialise a with a string. The textual string form. Initialise a using a string in its binary 'raw' form. Get a value indicating the original source of data for this instance. True if the source was a string; false if the source was binary data. Get the length of the comment when represented as raw bytes. Get the comment in its 'raw' form as plain bytes. Reset the comment to its initial state. Implicit conversion of comment to a string. The to convert to a string. The textual equivalent for the input value. An enumerator for Zip entries An is a stream that you can write uncompressed data to and flush, but cannot read, seek or do anything else to. Close this stream instance. Gets a value indicating whether the current stream supports reading. Write any buffered data to underlying storage. Gets a value indicating whether the current stream supports writing. Gets a value indicating whether the current stream supports seeking. Get the length in bytes of the stream. Gets or sets the position within the current stream. Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. The zero-based byte offset in buffer at which to begin storing the data read from the current stream. The maximum number of bytes to be read from the current stream. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. The sum of offset and count is larger than the buffer length. Methods were called after the stream was closed. The stream does not support reading. buffer is null. An I/O error occurs. offset or count is negative. Sets the position within the current stream. A byte offset relative to the origin parameter. A value of type indicating the reference point used to obtain the new position. The new position within the current stream. An I/O error occurs. The stream does not support seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed. Sets the length of the current stream. The desired length of the current stream in bytes. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. An I/O error occurs. Methods were called after the stream was closed. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. An array of bytes. This method copies count bytes from buffer to the current stream. The zero-based byte offset in buffer at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. An I/O error occurs. The stream does not support writing. Methods were called after the stream was closed. buffer is null. The sum of offset and count is greater than the buffer length. offset or count is negative. A is an whose data is only a part or subsection of a file. Initialise a new instance of the class. The containing the underlying stream to use for IO. The start of the partial data. The length of the partial data. Read a byte from this stream. Returns the byte read or -1 on end of stream. Close this partial input stream. The underlying stream is not closed. Close the parent ZipFile class to do that. Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. The zero-based byte offset in buffer at which to begin storing the data read from the current stream. The maximum number of bytes to be read from the current stream. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. The sum of offset and count is larger than the buffer length. Methods were called after the stream was closed. The stream does not support reading. buffer is null. An I/O error occurs. offset or count is negative. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. An array of bytes. This method copies count bytes from buffer to the current stream. The zero-based byte offset in buffer at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. An I/O error occurs. The stream does not support writing. Methods were called after the stream was closed. buffer is null. The sum of offset and count is greater than the buffer length. offset or count is negative. When overridden in a derived class, sets the length of the current stream. The desired length of the current stream in bytes. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. An I/O error occurs. Methods were called after the stream was closed. When overridden in a derived class, sets the position within the current stream. A byte offset relative to the origin parameter. A value of type indicating the reference point used to obtain the new position. The new position within the current stream. An I/O error occurs. The stream does not support seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed. Clears all buffers for this stream and causes any buffered data to be written to the underlying device. An I/O error occurs. Gets or sets the position within the current stream. The current position within the stream. An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed. Gets the length in bytes of the stream. A long value representing the length of the stream in bytes. A class derived from Stream does not support seeking. Methods were called after the stream was closed. Gets a value indicating whether the current stream supports writing. false true if the stream supports writing; otherwise, false. Gets a value indicating whether the current stream supports seeking. true true if the stream supports seeking; otherwise, false. Gets a value indicating whether the current stream supports reading. true. true if the stream supports reading; otherwise, false. Gets a value that determines whether the current stream can time out. A value that determines whether the current stream can time out. Provides a static way to obtain a source of data for an entry. Get a source of data by creating a new stream. Returns a to use for compression input. Ideally a new stream is created and opened to achieve this, to avoid locking problems. Represents a source of data that can dynamically provide multiple data sources based on the parameters passed. Get a data source. The to get a source for. The name for data if known. Returns a to use for compression input. Ideally a new stream is created and opened to achieve this, to avoid locking problems. Default implementation of a for use with files stored on disk. Initialise a new instnace of The name of the file to obtain data from. Get a providing data. Returns a provising data. Default implementation of for files stored on disk. Initialise a default instance of . Get a providing data for an entry. The entry to provide data for. The file name for data if known. Returns a stream providing data; or null if not available Defines facilities for data storage when updating Zip Archives. Get the to apply during updates. Get an empty that can be used for temporary output. Returns a temporary output Convert a temporary output stream to a final stream. The resulting final Make a temporary copy of the original stream. The to copy. Returns a temporary output that is a copy of the input. Return a stream suitable for performing direct updates on the original source. The current stream. Returns a stream suitable for direct updating. This may be the current stream passed. Dispose of this instance. An abstract suitable for extension by inheritance. Initializes a new instance of the class. The update mode. Gets a temporary output Returns the temporary output stream. Converts the temporary to its final form. Returns a that can be used to read the final storage for the archive. Make a temporary copy of a . The to make a copy of. Returns a temporary output that is a copy of the input. Return a stream suitable for performing direct updates on the original source. The to open for direct update. Returns a stream suitable for direct updating. Disposes this instance. Gets the update mode applicable. The update mode. An implementation suitable for hard disks. Initializes a new instance of the class. The file. The update mode. Initializes a new instance of the class. The file. Gets a temporary output for performing updates on. Returns the temporary output stream. Converts a temporary to its final form. Returns a that can be used to read the final storage for the archive. Make a temporary copy of a stream. The to copy. Returns a temporary output that is a copy of the input. Return a stream suitable for performing direct updates on the original source. The current stream. Returns a stream suitable for direct updating. If the stream is not null this is used as is. Disposes this instance. An implementation suitable for in memory streams. Initializes a new instance of the class. Initializes a new instance of the class. The to use This constructor is for testing as memory streams dont really require safe mode. Get the stream returned by if this was in fact called. Gets the temporary output Returns the temporary output stream. Converts the temporary to its final form. Returns a that can be used to read the final storage for the archive. Make a temporary copy of the original stream. The to copy. Returns a temporary output that is a copy of the input. Return a stream suitable for performing direct updates on the original source. The original source stream Returns a stream suitable for direct updating. If the passed is not null this is used; otherwise a new is returned. Disposes this instance. Basic implementation of Defines the possible values to be used for the . Use the recorded LastWriteTime value for the file. Use the recorded LastWriteTimeUtc value for the file Use the recorded CreateTime value for the file. Use the recorded CreateTimeUtc value for the file. Use the recorded LastAccessTime value for the file. Use the recorded LastAccessTimeUtc value for the file. Use a fixed value. The actual value used can be specified via the constructor or using the with the setting set to which will use the when this class was constructed. The property can also be used to set this value. Initialise a new instance of the class. A default , and the LastWriteTime for files is used. Initialise a new instance of using the specified The time setting to use when creating Zip entries. Initialise a new instance of using the specified The time to set all values to. Get / set the to be used when creating new values. Setting this property to null will cause a default name transform to be used. Get / set the in use. Get / set the value to use when is set to A bitmask defining the attributes to be retrieved from the actual file. The default is to get all possible attributes from the actual file. A bitmask defining which attributes are to be set on. By default no attributes are set on. Get set a value indicating wether unidoce text should be set on. Make a new for a file. The name of the file to create a new entry for. Returns a new based on the . Make a new from a name. The name of the file to create a new entry for. If true entry detail is retrieved from the file system if the file exists. Returns a new based on the . Make a new for a directory. The raw untransformed name for the new directory Returns a new representing a directory. Make a new for a directory. The raw untransformed name for the new directory If true entry detail is retrieved from the file system if the file exists. Returns a new representing a directory. WindowsNameTransform transforms names to windows compatible ones. Initialises a new instance of Initialise a default instance of Gets or sets a value containing the target directory to prefix values with. Gets or sets a value indicating wether paths on incoming values should be removed. Transform a Zip directory name to a windows directory name. The directory name to transform. The transformed name. Transform a Zip format file name to a windows style one. The file name to transform. The transformed name. Test a name to see if it is a valid name for a windows filename as extracted from a Zip archive. The name to test. Returns true if the name is a valid zip name; false otherwise. The filename isnt a true windows path in some fundamental ways like no absolute paths, no rooted paths etc. Initialise static class information. Force a name to be valid by replacing invalid characters with a fixed value The name to make valid The replacement character to use for any invalid characters. Returns a valid name Gets or set the character to replace invalid characters during transformations. The maximum windows path name permitted. This may not valid for all windows systems - CE?, etc but I cant find the equivalent in the CLR. Holds data pertinent to a data descriptor. Get /set the compressed size of data. Get / set the uncompressed size of data Get /set the crc value. This class assists with writing/reading from Zip files. Initialise an instance of this class. The name of the file to open. Initialise a new instance of . The stream to use. Get / set a value indicating wether the the underlying stream is owned or not. If the stream is owned it is closed when this instance is closed. Close the stream. The underlying stream is closed only if is true. Locates a block with the desired . The signature to find. Location, marking the end of block. Minimum size of the block. The maximum variable data. Eeturns the offset of the first byte after the signature; -1 if not found Write Zip64 end of central directory records (File header and locator). The number of entries in the central directory. The size of entries in the central directory. The offset of the dentral directory. Write the required records to end the central directory. The number of entries in the directory. The size of the entries in the directory. The start of the central directory. The archive comment. (This can be null). Read an unsigned short in little endian byte order. Returns the value read. An i/o error occurs. The file ends prematurely Read an int in little endian byte order. Returns the value read. An i/o error occurs. The file ends prematurely Read a long in little endian byte order. The value read. Write an unsigned short in little endian byte order. The value to write. Write a ushort in little endian byte order. The value to write. Write an int in little endian byte order. The value to write. Write a uint in little endian byte order. The value to write. Write a long in little endian byte order. The value to write. Write a ulong in little endian byte order. The value to write. Write a data descriptor. The entry to write a descriptor for. Returns the number of descriptor bytes written. Read data descriptor at the end of compressed data. if set to true [zip64]. The data to fill in. Returns the number of bytes read in the descriptor. This is an InflaterInputStream that reads the files baseInputStream an zip archive one after another. It has a special method to get the zip entry of the next file. The zip entry contains information about the file name size, compressed size, Crc, etc. It includes support for Stored and Deflated entries.

Author of the original java version : Jochen Hoenicke This sample shows how to read a zip file using System; using System.Text; using System.IO; using ICSharpCode.SharpZipLib.Zip; class MainClass { public static void Main(string[] args) { using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) { ZipEntry theEntry; const int size = 2048; byte[] data = new byte[2048]; while ((theEntry = s.GetNextEntry()) != null) { if ( entry.IsFile ) { Console.Write("Show contents (y/n) ?"); if (Console.ReadLine() == "y") { while (true) { size = s.Read(data, 0, data.Length); if (size > 0) { Console.Write(new ASCIIEncoding().GetString(data, 0, size)); } else { break; } } } } } } } } Delegate for reading bytes from a stream. The current reader this instance. Creates a new Zip input stream, for reading a zip archive. The underlying providing data. Creates a new Zip input stream, for reading a zip archive. The underlying providing data. Size of the buffer. Optional password used for encryption when non-null A password for all encrypted entries in this Gets a value indicating if there is a current entry and it can be decompressed The entry can only be decompressed if the library supports the zip features required to extract it. See the ZipEntry Version property for more details. Advances to the next entry in the archive The next entry in the archive or null if there are no more entries. If the previous entry is still open CloseEntry is called. Input stream is closed Password is not set, password is invalid, compression method is invalid, version required to extract is not supported Read data descriptor at the end of compressed data. Complete cleanup as the final part of closing. True if the crc value should be tested Closes the current zip entry and moves to the next one. The stream is closed The Zip stream ends early Returns 1 if there is an entry available Otherwise returns 0. Returns the current size that can be read from the current entry if available Thrown if the entry size is not known. Thrown if no entry is currently available. Reads a byte from the current zip entry. The byte or -1 if end of stream is reached. Handle attempts to read by throwing an . The destination array to store data in. The offset at which data read should be stored. The maximum number of bytes to read. Returns the number of bytes actually read. Handle attempts to read from this entry by throwing an exception Perform the initial read on an entry which may include reading encryption headers and setting up inflation. The destination to fill with data read. The offset to start reading at. The maximum number of bytes to read. The actual number of bytes read. Read a block of bytes from the stream. The destination for the bytes. The index to start storing data. The number of bytes to attempt to read. Returns the number of bytes read. Zero bytes read means end of stream. Reads a block of bytes from the current zip entry. The number of bytes read (this may be less than the length requested, even before the end of stream), or 0 on end of stream. An i/o error occured. The deflated stream is corrupted. The stream is not open. Closes the zip input stream FastZipEvents supports all events applicable to FastZip operations. Delegate to invoke when processing directories. Delegate to invoke when processing files. Delegate to invoke during processing of files. Delegate to invoke when processing for a file has been completed. Delegate to invoke when processing directory failures. Delegate to invoke when processing file failures. Raise the directory failure event. The directory causing the failure. The exception for this event. A boolean indicating if execution should continue or not. Fires the file failure handler delegate. The file causing the failure. The exception for this failure. A boolean indicating if execution should continue or not. Fires the ProcessFile delegate. The file being processed. A boolean indicating if execution should continue or not. Fires the delegate The file whose processing has been completed. A boolean indicating if execution should continue or not. Fires the process directory delegate. The directory being processed. Flag indicating if the directory has matching files as determined by the current filter. A of true if the operation should continue; false otherwise. The minimum timespan between events. The minimum period of time between events. The default interval is three seconds. FastZip provides facilities for creating and extracting zip files. Defines the desired handling when overwriting files during extraction. Prompt the user to confirm overwriting Never overwrite files. Always overwrite files. Initialise a default instance of . Initialise a new instance of The events to use during operations. Get/set a value indicating wether empty directories should be created. Get / set the password value. Get or set the active when creating Zip files. Get or set the active when creating Zip files. Gets or sets the setting for Zip64 handling when writing. The default value is dynamic which is not backwards compatible with old programs and can cause problems with XP's built in compression which cant read Zip64 archives. However it does avoid the situation were a large file is added and cannot be completed correctly. NOTE: Setting the size for entries before they are added is the best solution! By default the EntryFactory used by FastZip will set fhe file size. Get/set a value indicating wether file dates and times should be restored when extracting files from an archive. The default value is false. Get/set a value indicating wether file attributes should be restored during extract operations Delegate called when confirming overwriting of files. Create a zip file. The name of the zip file to create. The directory to source files from. True to recurse directories, false for no recursion. The file filter to apply. The directory filter to apply. Create a zip file/archive. The name of the zip file to create. The directory to obtain files and directories from. True to recurse directories, false for no recursion. The file filter to apply. Create a zip archive sending output to the passed. The stream to write archive data to. The directory to source files from. True to recurse directories, false for no recursion. The file filter to apply. The directory filter to apply. The is closed after creation. Extract the contents of a zip file. The zip file to extract from. The directory to save extracted information in. A filter to apply to files. Extract the contents of a zip file. The zip file to extract from. The directory to save extracted information in. The style of overwriting to apply. A delegate to invoke when confirming overwriting. A filter to apply to files. A filter to apply to directories. Flag indicating whether to restore the date and time for extracted files. Extract the contents of a zip file held in a stream. The seekable input stream containing the zip to extract from. The directory to save extracted information in. The style of overwriting to apply. A delegate to invoke when confirming overwriting. A filter to apply to files. A filter to apply to directories. Flag indicating whether to restore the date and time for extracted files. Flag indicating whether the inputStream will be closed by this method. Defines factory methods for creating new values. Create a for a file given its name The name of the file to create an entry for. Returns a file entry based on the passed. Create a for a file given its name The name of the file to create an entry for. If true get details from the file system if the file exists. Returns a file entry based on the passed. Create a for a directory given its name The name of the directory to create an entry for. Returns a directory entry based on the passed. Create a for a directory given its name The name of the directory to create an entry for. If true get details from the file system for this directory if it exists. Returns a directory entry based on the passed. Get/set the applicable. ZipNameTransform transforms names as per the Zip file naming convention. The use of absolute names is supported although its use is not valid according to Zip naming conventions, and should not be used if maximum compatability is desired. Initialize a new instance of Initialize a new instance of The string to trim from the front of paths if found. Static constructor. Transform a windows directory name according to the Zip file naming conventions. The directory name to transform. The transformed name. Transform a windows file name according to the Zip file naming conventions. The file name to transform. The transformed name. Get/set the path prefix to be trimmed from paths if present. The prefix is trimmed before any conversion from a windows path is done. Force a name to be valid by replacing invalid characters with a fixed value The name to force valid The replacement character to use. Returns a valid name Test a name to see if it is a valid name for a zip entry. The name to test. If true checking is relaxed about windows file names and absolute paths. Returns true if the name is a valid zip name; false otherwise. Zip path names are actually in Unix format, and should only contain relative paths. This means that any path stored should not contain a drive or device letter, or a leading slash. All slashes should forward slashes '/'. An empty name is valid for a file where the input comes from standard input. A null name is not considered valid. Test a name to see if it is a valid name for a zip entry. The name to test. Returns true if the name is a valid zip name; false otherwise. Zip path names are actually in unix format, and should only contain relative paths if a path is present. This means that the path stored should not contain a drive or device letter, or a leading slash. All slashes should forward slashes '/'. An empty name is valid where the input comes from standard input. A null name is not considered valid. This class allows us to retrieve a specified number of bits from the input buffer, as well as copy big byte blocks. It uses an int buffer to store up to 31 bits for direct manipulation. This guarantees that we can get at least 16 bits, but we only need at most 15, so this is all safe. There are some optimizations in this class, for example, you must never peek more than 8 bits more than needed, and you must first peek bits before you may drop them. This is not a general purpose class but optimized for the behaviour of the Inflater. authors of the original java version : John Leuner, Jochen Hoenicke Constructs a default StreamManipulator with all buffers empty Get the next sequence of bits but don't increase input pointer. bitCount must be less or equal 16 and if this call succeeds, you must drop at least n - 8 bits in the next call. The number of bits to peek. the value of the bits, or -1 if not enough bits available. */ Drops the next n bits from the input. You should have called PeekBits with a bigger or equal n before, to make sure that enough bits are in the bit buffer. The number of bits to drop. Gets the next n bits and increases input pointer. This is equivalent to followed by , except for correct error handling. The number of bits to retrieve. the value of the bits, or -1 if not enough bits available. Gets the number of bits available in the bit buffer. This must be only called when a previous PeekBits() returned -1. the number of bits available. Gets the number of bytes available. The number of bytes available. Skips to the next byte boundary. Returns true when SetInput can be called Copies bytes from input buffer to output buffer starting at output[offset]. You have to make sure, that the buffer is byte aligned. If not enough bytes are available, copies fewer bytes. The buffer to copy bytes to. The offset in the buffer at which copying starts The length to copy, 0 is allowed. The number of bytes copied, 0 if no bytes were available. Length is less than zero Bit buffer isnt byte aligned Resets state and empties internal buffers Add more input for consumption. Only call when IsNeedingInput returns true data to be input offset of first byte of input number of bytes of input to add. An input buffer customised for use by The buffer supports decryption of incoming data. Initialise a new instance of with a default buffer size The stream to buffer. Initialise a new instance of The stream to buffer. The size to use for the buffer A minimum buffer size of 1KB is permitted. Lower sizes are treated as 1KB. Get the length of bytes bytes in the Get the contents of the raw data buffer. This may contain encrypted data. Get the number of useable bytes in Get the contents of the clear text buffer. Get/set the number of bytes available Call passing the current clear text buffer contents. The inflater to set input for. Fill the buffer from the underlying input stream. Read a buffer directly from the input stream The buffer to fill Returns the number of bytes read. Read a buffer directly from the input stream The buffer to read into The offset to start reading data into. The number of bytes to read. Returns the number of bytes read. Read clear text data from the input stream. The buffer to add data to. The offset to start adding data at. The number of bytes to read. Returns the number of bytes actually read. Read a from the input stream. Returns the byte read. Read an in little endian byte order. The short value read case to an int. Read an in little endian byte order. The int value read. Read a in little endian byte order. The long value read. Get/set the to apply to any data. Set this value to null to have no transform applied. This filter stream is used to decompress data compressed using the "deflate" format. The "deflate" format is described in RFC 1951. This stream may form the basis for other decompression filters, such as the GZipInputStream. Author of the original java version : John Leuner. Create an InflaterInputStream with the default decompressor and a default buffer size of 4KB. The InputStream to read bytes from Create an InflaterInputStream with the specified decompressor and a default buffer size of 4KB. The source of input data The decompressor used to decompress data read from baseInputStream Create an InflaterInputStream with the specified decompressor and the specified buffer size. The InputStream to read bytes from The decompressor to use Size of the buffer to use Get/set flag indicating ownership of underlying stream. When the flag is true will close the underlying stream also. The default value is true. Skip specified number of bytes of uncompressed data Number of bytes to skip The number of bytes skipped, zero if the end of stream has been reached The number of bytes to skip is less than or equal to zero. Clear any cryptographic state. Returns 0 once the end of the stream (EOF) has been reached. Otherwise returns 1. Fills the buffer with more data to decompress. Stream ends early Gets a value indicating whether the current stream supports reading Gets a value of false indicating seeking is not supported for this stream. Gets a value of false indicating that this stream is not writeable. A value representing the length of the stream in bytes. The current position within the stream. Throws a NotSupportedException when attempting to set the position Attempting to set the position Flushes the baseInputStream Sets the position within the current stream Always throws a NotSupportedException The relative offset to seek to. The defining where to seek from. The new position in the stream. Any access Set the length of the current stream Always throws a NotSupportedException The new length value for the stream. Any access Writes a sequence of bytes to stream and advances the current position This method always throws a NotSupportedException Thew buffer containing data to write. The offset of the first byte to write. The number of bytes to write. Any access Writes one byte to the current stream and advances the current position Always throws a NotSupportedException The byte to write. Any access Entry point to begin an asynchronous write. Always throws a NotSupportedException. The buffer to write data from Offset of first byte to write The maximum number of bytes to write The method to be called when the asynchronous write operation is completed A user-provided object that distinguishes this particular asynchronous write request from other requests An IAsyncResult that references the asynchronous write Any access Closes the input stream. When is true the underlying stream is also closed. Reads decompressed data into the provided buffer byte array The array to read and decompress data into The offset indicating where the data should be placed The number of bytes to decompress The number of bytes read. Zero signals the end of stream Inflater needs a dictionary Decompressor for this stream Input buffer for this stream. Base stream the inflater reads from. The compressed size Flag indicating wether this instance has been closed or not. Flag indicating wether this instance is designated the stream owner. When closing if this flag is true the underlying stream is closed. Contains the output from the Inflation process. We need to have a window so that we can refer backwards into the output stream to repeat stuff.
Author of the original java version : John Leuner Write a byte to this output window value to write if window is full Append a byte pattern already in the window itself length of pattern to copy distance from end of window pattern occurs If the repeated data overflows the window Copy from input manipulator to internal window source of data length of data to copy the number of bytes copied Copy dictionary to window source dictionary offset of start in source dictionary length of dictionary If window isnt empty Get remaining unfilled space in window Number of bytes left in window Get bytes available for output in window Number of bytes filled Copy contents of window to output buffer to copy to offset to start at number of bytes to count The number of bytes copied If a window underflow occurs Reset by clearing window so GetAvailable returns 0 A special stream deflating or compressing the bytes that are written to it. It uses a Deflater to perform actual deflating.
Authors of the original java version : Tom Tromey, Jochen Hoenicke Creates a new DeflaterOutputStream with a default Deflater and default buffer size. the output stream where deflated output should be written. Creates a new DeflaterOutputStream with the given Deflater and default buffer size. the output stream where deflated output should be written. the underlying deflater. Creates a new DeflaterOutputStream with the given Deflater and buffer size. The output stream where deflated output is written. The underlying deflater to use The buffer size in bytes to use when deflating (minimum value 512) bufsize is less than or equal to zero. baseOutputStream does not support writing deflater instance is null Finishes the stream by calling finish() on the deflater. Not all input is deflated Get/set flag indicating ownership of the underlying stream. When the flag is true will close the underlying stream also. Allows client to determine if an entry can be patched after its added Returns the 10 byte AUTH CODE to be appended immediately following the AES data stream. Get/set the password used for encryption. When set to null or if the password is empty no encryption is performed Encrypt a block of data Data to encrypt. NOTE the original contents of the buffer are lost Offset of first byte in buffer to encrypt Number of bytes in buffer to encrypt Initializes encryption keys based on given . The password. Initializes encryption keys based on given password. Deflates everything in the input buffers. This will call def.deflate() until all bytes from the input buffers are processed. Gets value indicating stream can be read from Gets a value indicating if seeking is supported for this stream This property always returns false Get value indicating if this stream supports writing Get current length of stream Gets the current position within the stream. Any attempt to set position Sets the current position of this stream to the given value. Not supported by this class! The offset relative to the to seek. The to seek from. The new position in the stream. Any access Sets the length of this stream to the given value. Not supported by this class! The new stream length. Any access Read a byte from stream advancing position by one The byte read cast to an int. THe value is -1 if at the end of the stream. Any access Read a block of bytes from stream The buffer to store read data in. The offset to start storing at. The maximum number of bytes to read. The actual number of bytes read. Zero if end of stream is detected. Any access Asynchronous reads are not supported a NotSupportedException is always thrown The buffer to read into. The offset to start storing data at. The number of bytes to read The async callback to use. The state to use. Returns an Any access Asynchronous writes arent supported, a NotSupportedException is always thrown The buffer to write. The offset to begin writing at. The number of bytes to write. The to use. The state object. Returns an IAsyncResult. Any access Flushes the stream by calling Flush on the deflater and then on the underlying stream. This ensures that all bytes are flushed. Calls and closes the underlying stream when is true. Writes a single byte to the compressed output stream. The byte value. Writes bytes from an array to the compressed stream. The byte array The offset into the byte array where to start. The number of bytes to write. This buffer is used temporarily to retrieve the bytes from the deflater and write them to the underlying output stream. The deflater which is used to deflate the stream. Base stream the deflater depends on. This class stores the pending output of the Deflater. author of the original java version : Jochen Hoenicke Construct instance with default buffer size This is the Deflater class. The deflater class compresses input with the deflate algorithm described in RFC 1951. It has several compression levels and three different strategies described below. This class is not thread safe. This is inherent in the API, due to the split of deflate and setInput. author of the original java version : Jochen Hoenicke The best and slowest compression level. This tries to find very long and distant string repetitions. The worst but fastest compression level. The default compression level. This level won't compress at all but output uncompressed blocks. The compression method. This is the only method supported so far. There is no need to use this constant at all. Creates a new deflater with default compression level. Creates a new deflater with given compression level. the compression level, a value between NO_COMPRESSION and BEST_COMPRESSION, or DEFAULT_COMPRESSION. if lvl is out of range. Creates a new deflater with given compression level. the compression level, a value between NO_COMPRESSION and BEST_COMPRESSION. true, if we should suppress the Zlib/RFC1950 header at the beginning and the adler checksum at the end of the output. This is useful for the GZIP/PKZIP formats. if lvl is out of range. Resets the deflater. The deflater acts afterwards as if it was just created with the same compression level and strategy as it had before. Gets the current adler checksum of the data that was processed so far. Gets the number of input bytes processed so far. Gets the number of output bytes so far. Flushes the current input block. Further calls to deflate() will produce enough output to inflate everything in the current input block. This is not part of Sun's JDK so I have made it package private. It is used by DeflaterOutputStream to implement flush(). Finishes the deflater with the current input block. It is an error to give more input after this method was called. This method must be called to force all bytes to be flushed. Returns true if the stream was finished and no more output bytes are available. Returns true, if the input buffer is empty. You should then call setInput(). NOTE: This method can also return true when the stream was finished. Sets the data which should be compressed next. This should be only called when needsInput indicates that more input is needed. If you call setInput when needsInput() returns false, the previous input that is still pending will be thrown away. The given byte array should not be changed, before needsInput() returns true again. This call is equivalent to setInput(input, 0, input.length). the buffer containing the input data. if the buffer was finished() or ended(). Sets the data which should be compressed next. This should be only called when needsInput indicates that more input is needed. The given byte array should not be changed, before needsInput() returns true again. the buffer containing the input data. the start of the data. the number of data bytes of input. if the buffer was Finish()ed or if previous input is still pending. Sets the compression level. There is no guarantee of the exact position of the change, but if you call this when needsInput is true the change of compression level will occur somewhere near before the end of the so far given input. the new compression level. Get current compression level Returns the current compression level Sets the compression strategy. Strategy is one of DEFAULT_STRATEGY, HUFFMAN_ONLY and FILTERED. For the exact position where the strategy is changed, the same as for SetLevel() applies. The new compression strategy. Deflates the current input block with to the given array. The buffer where compressed data is stored The number of compressed bytes added to the output, or 0 if either IsNeedingInput() or IsFinished returns true or length is zero. Deflates the current input block to the given array. Buffer to store the compressed data. Offset into the output array. The maximum number of bytes that may be stored. The number of compressed bytes added to the output, or 0 if either needsInput() or finished() returns true or length is zero. If Finish() was previously called. If offset or length don't match the array length. Sets the dictionary which should be used in the deflate process. This call is equivalent to setDictionary(dict, 0, dict.Length). the dictionary. if SetInput () or Deflate () were already called or another dictionary was already set. Sets the dictionary which should be used in the deflate process. The dictionary is a byte array containing strings that are likely to occur in the data which should be compressed. The dictionary is not stored in the compressed output, only a checksum. To decompress the output you need to supply the same dictionary again. The dictionary data The index where dictionary information commences. The number of bytes in the dictionary. If SetInput () or Deflate() were already called or another dictionary was already set. Compression level. If true no Zlib/RFC1950 headers or footers are generated The current state. The total bytes of output written. The pending output. The deflater engine. Inflater is used to decompress data that has been compressed according to the "deflate" standard described in rfc1951. By default Zlib (rfc1950) headers and footers are expected in the input. You can use constructor public Inflater(bool noHeader) passing true if there is no Zlib header information The usage is as following. First you have to set some input with SetInput(), then Inflate() it. If inflate doesn't inflate any bytes there may be three reasons:
  • IsNeedingInput() returns true because the input buffer is empty. You have to provide more input with SetInput(). NOTE: IsNeedingInput() also returns true when, the stream is finished.
  • IsNeedingDictionary() returns true, you have to provide a preset dictionary with SetDictionary().
  • IsFinished returns true, the inflater has finished.
Once the first output byte is produced, a dictionary will not be needed at a later stage. author of the original java version : John Leuner, Jochen Hoenicke Copy lengths for literal codes 257..285 Extra bits for literal codes 257..285 Copy offsets for distance codes 0..29 Extra bits for distance codes These are the possible states for an inflater This variable contains the current state. The adler checksum of the dictionary or of the decompressed stream, as it is written in the header resp. footer of the compressed stream. Only valid if mode is DECODE_DICT or DECODE_CHKSUM. The number of bits needed to complete the current state. This is valid, if mode is DECODE_DICT, DECODE_CHKSUM, DECODE_HUFFMAN_LENBITS or DECODE_HUFFMAN_DISTBITS. True, if the last block flag was set in the last block of the inflated stream. This means that the stream ends after the current block. The total number of inflated bytes. The total number of bytes set with setInput(). This is not the value returned by the TotalIn property, since this also includes the unprocessed input. This variable stores the noHeader flag that was given to the constructor. True means, that the inflated stream doesn't contain a Zlib header or footer. Creates a new inflater or RFC1951 decompressor RFC1950/Zlib headers and footers will be expected in the input data Creates a new inflater. True if no RFC1950/Zlib header and footer fields are expected in the input data This is used for GZIPed/Zipped input. For compatibility with Sun JDK you should provide one byte of input more than needed in this case. Resets the inflater so that a new stream can be decompressed. All pending input and output will be discarded. Decodes a zlib/RFC1950 header. False if more input is needed. The header is invalid. Decodes the dictionary checksum after the deflate header. False if more input is needed. Decodes the huffman encoded symbols in the input stream. false if more input is needed, true if output window is full or the current block ends. if deflated stream is invalid. Decodes the adler checksum after the deflate stream. false if more input is needed. If checksum doesn't match. Decodes the deflated stream. false if more input is needed, or if finished. if deflated stream is invalid. Sets the preset dictionary. This should only be called, if needsDictionary() returns true and it should set the same dictionary, that was used for deflating. The getAdler() function returns the checksum of the dictionary needed. The dictionary. Sets the preset dictionary. This should only be called, if needsDictionary() returns true and it should set the same dictionary, that was used for deflating. The getAdler() function returns the checksum of the dictionary needed. The dictionary. The index into buffer where the dictionary starts. The number of bytes in the dictionary. No dictionary is needed. The adler checksum for the buffer is invalid Sets the input. This should only be called, if needsInput() returns true. the input. Sets the input. This should only be called, if needsInput() returns true. The source of input data The index into buffer where the input starts. The number of bytes of input to use. No input is needed. The index and/or count are wrong. Inflates the compressed stream to the output buffer. If this returns 0, you should check, whether IsNeedingDictionary(), IsNeedingInput() or IsFinished() returns true, to determine why no further output is produced. the output buffer. The number of bytes written to the buffer, 0 if no further output can be produced. if buffer has length 0. if deflated stream is invalid. Inflates the compressed stream to the output buffer. If this returns 0, you should check, whether needsDictionary(), needsInput() or finished() returns true, to determine why no further output is produced. the output buffer. the offset in buffer where storing starts. the maximum number of bytes to output. the number of bytes written to the buffer, 0 if no further output can be produced. if count is less than 0. if the index and / or count are wrong. if deflated stream is invalid. Returns true, if the input buffer is empty. You should then call setInput(). NOTE: This method also returns true when the stream is finished. Returns true, if a preset dictionary is needed to inflate the input. Returns true, if the inflater has finished. This means, that no input is needed and no output can be produced. Gets the adler checksum. This is either the checksum of all uncompressed bytes returned by inflate(), or if needsDictionary() returns true (and thus no output was yet produced) this is the adler checksum of the expected dictionary. the adler checksum. Gets the total number of output bytes returned by Inflate(). the total number of output bytes. Gets the total number of processed compressed input bytes. The total number of bytes of processed input bytes. Gets the number of unprocessed input bytes. Useful, if the end of the stream is reached and you want to further process the bytes after the deflate stream. The number of bytes of the input which have not been processed. Huffman tree used for inflation Literal length tree Distance tree Constructs a Huffman tree from the array of code lengths. the array of code lengths Reads the next symbol from input. The symbol is encoded using the huffman tree. input the input source. the next symbol, or -1 if not enough input is available. The current decode mode This is the DeflaterHuffman class. This class is not thread safe. This is inherent in the API, due to the split of Deflate and SetInput. author of the original java version : Jochen Hoenicke Resets the internal state of the tree Check that all frequencies are zero At least one frequency is non-zero Set static codes and length new codes length for new codes Build dynamic codes and lengths Get encoded length Encoded length, the sum of frequencies * lengths Scan a literal or distance tree to determine the frequencies of the codes in the bit length tree. Write tree values Tree to write Pending buffer to use Construct instance with pending buffer Pending buffer to use Reset internal state Write all trees to pending buffer The number/rank of treecodes to send. Compress current buffer writing data to pending buffer Flush block to output with no compression Data to write Index of first byte to write Count of bytes to write True if this is the last block Flush block to output with compression Data to flush Index of first byte to flush Count of bytes to flush True if this is the last block Get value indicating if internal buffer is full true if buffer is full Add literal to buffer Literal value to add to buffer. Value indicating internal buffer is full Add distance code and length to literal and distance trees Distance code Length Value indicating if internal buffer is full Reverse the bits of a 16 bit value. Value to reverse bits Value with bits reversed This class contains constants used for deflation. Set to true to enable debugging Written to Zip file to identify a stored block Identifies static tree in Zip file Identifies dynamic tree in Zip file Header flag indicating a preset dictionary for deflation Sets internal buffer sizes for Huffman encoding Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant Internal compression engine constant This class is general purpose class for writing data to a buffer. It allows you to write bits as well as bytes Based on DeflaterPending.java author of the original java version : Jochen Hoenicke Internal work buffer construct instance using default buffer size of 4096 construct instance using specified buffer size size to use for internal buffer Clear internal state/buffers Write a byte to buffer The value to write Write a short value to buffer LSB first The value to write. write an integer LSB first The value to write. Write a block of data to buffer data to write offset of first byte to write number of bytes to write The number of bits written to the buffer Align internal buffer on a byte boundary Write bits to internal buffer source of bits number of bits to write Write a short value to internal buffer most significant byte first value to write Indicates if buffer has been flushed Flushes the pending buffer into the given output array. If the output array is to small, only a partial flush is done. The output array. The offset into output array. The maximum number of bytes to store. The number of bytes flushed. Convert internal buffer to byte array. Buffer is empty on completion The internal buffer contents converted to a byte array. Strategies for deflater The default strategy This strategy will only allow longer string repetitions. It is useful for random data with a small character set. This strategy will not look for string repetitions at all. It only encodes with Huffman trees (which means, that more common characters get a smaller encoding. Low level compression engine for deflate algorithm which uses a 32K sliding window with secondary compression from Huffman/Shannon-Fano codes. Construct instance with pending buffer Pending buffer to use > Deflate drives actual compression of data True to flush input buffers Finish deflation with the current input. Returns true if progress has been made. Sets input data to be deflated. Should only be called when NeedsInput() returns true The buffer containing input data. The offset of the first byte of data. The number of bytes of data to use as input. Determines if more input is needed. Return true if input is needed via SetInput Set compression dictionary The buffer containing the dictionary data The offset in the buffer for the first byte of data The length of the dictionary data. Reset internal state Reset Adler checksum Get current value of Adler checksum Total data processed Get/set the deflate strategy Set the deflate level (0-9) The value to set the level to. Fill the window Inserts the current string in the head hash and returns the previous value for this hash. The previous hash value Find the best (longest) string in the window matching the string starting at strstart. Preconditions: strstart + MAX_MATCH <= window.length. True if a match greater than the minimum length is found Hashtable, hashing three characters to an index for window, so that window[index]..window[index+2] have this hash code. Note that the array should really be unsigned short, so you need to and the values with 0xffff. prev[index & WMASK] points to the previous index that has the same hash code as the string starting at index. This way entries with the same hash code are in a linked list. Note that the array should really be unsigned short, so you need to and the values with 0xffff. Points to the current character in the window. lookahead is the number of characters starting at strstart in window that are valid. So window[strstart] until window[strstart+lookahead-1] are valid characters. This array contains the part of the uncompressed stream that is of relevance. The current character is indexed by strstart. The current compression function. The input data for compression. The total bytes of input read. The offset into inputBuf, where input data starts. The end offset of the input data. The adler checksum Represents exception conditions specific to Zip archive handling Deserialization constructor for this constructor for this constructor Initializes a new instance of the ZipException class. Initializes a new instance of the ZipException class with a specified error message. The error message that explains the reason for the exception. Initialise a new instance of ZipException. A message describing the error. The exception that is the cause of the current exception. ExtraData tagged value interface. Get the ID for this tagged data value. Set the contents of this instance from the data passed. The data to extract contents from. The offset to begin extracting data from. The number of bytes to extract. Get the data representing this instance. Returns the data for this instance. A raw binary tagged value Initialise a new instance. The tag ID. Get the ID for this tagged data value. Set the data from the raw values provided. The raw data to extract values from. The index to start extracting values from. The number of bytes available. Get the binary data representing this instance. The raw binary data representing this instance. Get /set the binary data representing this instance. The raw binary data representing this instance. The tag ID for this instance. Class representing extended unix date time values. Flags indicate which values are included in this instance. The modification time is included The access time is included The create time is included. Get the ID Set the data from the raw values provided. The raw data to extract values from. The index to start extracting values from. The number of bytes available. Get the binary data representing this instance. The raw binary data representing this instance. Test a value to see if is valid and can be represented here. The value to test. Returns true if the value is valid and can be represented; false if not. The standard Unix time is a signed integer data type, directly encoding the Unix time number, which is the number of seconds since 1970-01-01. Being 32 bits means the values here cover a range of about 136 years. The minimum representable time is 1901-12-13 20:45:52, and the maximum representable time is 2038-01-19 03:14:07. Get /set the Modification Time Get / set the Access Time Get / Set the Create Time Get/set the values to include. Class handling NT date time values. Get the ID for this tagged data value. Set the data from the raw values provided. The raw data to extract values from. The index to start extracting values from. The number of bytes available. Get the binary data representing this instance. The raw binary data representing this instance. Test a valuie to see if is valid and can be represented here. The value to test. Returns true if the value is valid and can be represented; false if not. NTFS filetimes are 64-bit unsigned integers, stored in Intel (least significant byte first) byte order. They determine the number of 1.0E-07 seconds (1/10th microseconds!) past WinNT "epoch", which is "01-Jan-1601 00:00:00 UTC". 28 May 60056 is the upper limit Get/set the last modification time. Get /set the create time Get /set the last access time. A factory that creates tagged data instances. Get data for a specific tag value. The tag ID to find. The data to search. The offset to begin extracting data from. The number of bytes to extract. The located value found, or null if not found. A class to handle the extra data field for Zip entries Extra data contains 0 or more values each prefixed by a header tag and length. They contain zero or more bytes of actual data. The data is held internally using a copy on write strategy. This is more efficient but means that for extra data created by passing in data can have the values modified by the caller in some circumstances. Initialise a default instance. Initialise with known extra data. The extra data. Get the raw extra data value Returns the raw byte[] extra data this instance represents. Clear the stored data. Gets the current extra data length. Get a read-only for the associated tag. The tag to locate data for. Returns a containing tag data or null if no tag was found. Get the tagged data for a tag. The tag to search for. Returns a tagged value or null if none found. Get the length of the last value found by This is only valid if has previously returned true. Get the index for the current read value. This is only valid if has previously returned true. Initially the result will be the index of the first byte of actual data. The value is updated after calls to , and . Get the number of bytes remaining to be read for the current value; Find an extra data value The identifier for the value to find. Returns true if the value was found; false otherwise. Add a new entry to extra data. The value to add. Add a new entry to extra data The ID for this entry. The data to add. If the ID already exists its contents are replaced. Start adding a new entry. Add data using , , , or . The new entry is completed and actually added by calling Add entry data added since using the ID passed. The identifier to use for this entry. Add a byte of data to the pending new entry. The byte to add. Add data to a pending new entry. The data to add. Add a short value in little endian order to the pending new entry. The data to add. Add an integer value in little endian order to the pending new entry. The data to add. Add a long value in little endian order to the pending new entry. The data to add. Delete an extra data field. The identifier of the field to delete. Returns true if the field was found and deleted. Read a long in little endian form from the last found data value Returns the long value read. Read an integer in little endian form from the last found data value. Returns the integer read. Read a short value in little endian form from the last found data value. Returns the short value read. Read a byte from an extra data The byte value read or -1 if the end of data has been reached. Skip data during reading. The number of bytes to skip. Internal form of that reads data at any location. Returns the short value read. Dispose of this instance. This is a DeflaterOutputStream that writes the files into a zip archive one after another. It has a special method to start a new zip entry. The zip entries contains information about the file name size, compressed size, CRC, etc. It includes support for Stored and Deflated entries. This class is not thread safe.

Author of the original java version : Jochen Hoenicke This sample shows how to create a zip file using System; using System.IO; using ICSharpCode.SharpZipLib.Core; using ICSharpCode.SharpZipLib.Zip; class MainClass { public static void Main(string[] args) { string[] filenames = Directory.GetFiles(args[0]); byte[] buffer = new byte[4096]; using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) { s.SetLevel(9); // 0 - store only to 9 - means best compression foreach (string file in filenames) { ZipEntry entry = new ZipEntry(file); s.PutNextEntry(entry); using (FileStream fs = File.OpenRead(file)) { StreamUtils.Copy(fs, s, buffer); } } } } } Creates a new Zip output stream, writing a zip archive. The output stream to which the archive contents are written. Creates a new Zip output stream, writing a zip archive. The output stream to which the archive contents are written. Size of the buffer to use. Gets a flag value of true if the central header has been added for this archive; false if it has not been added. No further entries can be added once this has been done. Set the zip file comment. The comment text for the entire archive. The converted comment is longer than 0xffff bytes. Sets the compression level. The new level will be activated immediately. The new compression level (1 to 9). Level specified is not supported. Get the current deflater compression level The current compression level Get / set a value indicating how Zip64 Extension usage is determined when adding entries. Older archivers may not understand Zip64 extensions. If backwards compatability is an issue be careful when adding entries to an archive. Setting this property to off is workable but less desirable as in those circumstances adding a file larger then 4GB will fail. Write an unsigned short in little endian byte order. Write an int in little endian byte order. Write an int in little endian byte order. Starts a new Zip entry. It automatically closes the previous entry if present. All entry elements bar name are optional, but must be correct if present. If the compression method is stored and the output is not patchable the compression for that entry is automatically changed to deflate level 0 the entry. if entry passed is null. if an I/O error occured. if stream was finished Too many entries in the Zip file
Entry name is too long
Finish has already been called
 Closes the current entry, updating header and footer information as required An I/O error occurs. No entry is active. Writes the given buffer to the current entry. The buffer containing data to write. The offset of the first byte to write. The number of bytes to write. Archive size is invalid No entry is active. Finishes the stream. This will write the central directory at the end of the zip file and flush the stream. This is automatically called when the stream is closed. An I/O error occurs. Comment exceeds the maximum length
Entry name exceeds the maximum length The entries for the archive. Used to track the crc of data added to entries. The current entry being added. Used to track the size of data for an entry during writing. Offset to be recorded for each entry in the central header. Comment for the entire archive recorded in central header. Flag indicating that header patching is required for the current entry. Position to patch crc Position to patch size. Defines known values for the property. Host system = MSDOS Host system = Amiga Host system = Open VMS Host system = Unix Host system = VMCms Host system = Atari ST Host system = OS2 Host system = Macintosh Host system = ZSystem Host system = Cpm Host system = Windows NT Host system = MVS Host system = VSE Host system = Acorn RISC Host system = VFAT Host system = Alternate MVS Host system = BEOS Host system = Tandem Host system = OS400 Host system = OSX Host system = WinZIP AES This class represents an entry in a zip archive. This can be a file or a directory ZipFile and ZipInputStream will give you instances of this class as information about the members in an archive. ZipOutputStream uses an instance of this class when creating an entry in a Zip file.

Author of the original java version : Jochen Hoenicke Creates a zip entry with the given name. The name for this entry. Can include directory components. The convention for names is 'unix' style paths with relative names only. There are with no device names and path elements are separated by '/' characters. The name passed is null Creates a zip entry with the given name and version required to extract The name for this entry. Can include directory components. The convention for names is 'unix' style paths with no device names and path elements separated by '/' characters. This is not enforced see CleanName on how to ensure names are valid if this is desired. The minimum 'feature version' required this entry The name passed is null Initializes an entry with the given name and made by information Name for this entry Version and HostSystem Information Minimum required zip feature version required to extract this entry Compression method for this entry. The name passed is null versionRequiredToExtract should be 0 (auto-calculate) or > 10 This constructor is used by the ZipFile class when reading from the central header It is not generally useful, use the constructor specifying the name only. Creates a deep copy of the given zip entry. The entry to copy. Get a value indicating wether the entry has a CRC value available. Get/Set flag indicating if entry is encrypted. A simple helper routine to aid interpretation of flags This is an assistant that interprets the flags property. Get / set a flag indicating wether entry name and comment text are encoded in unicode UTF8. This is an assistant that interprets the flags property. Value used during password checking for PKZIP 2.0 / 'classic' encryption. Get/Set general purpose bit flag for entry General purpose bit flag

Bit 0: If set, indicates the file is encrypted
Bit 1-2 Only used for compression type 6 Imploding, and 8, 9 deflating
Imploding:
Bit 1 if set indicates an 8K sliding dictionary was used. If clear a 4k dictionary was used
Bit 2 if set indicates 3 Shannon-Fanno trees were used to encode the sliding dictionary, 2 otherwise

Deflating:
Bit 2 Bit 1
0 0 Normal compression was used
0 1 Maximum compression was used
1 0 Fast compression was used
1 1 Super fast compression was used

Bit 3: If set, the fields crc-32, compressed size and uncompressed size are were not able to be written during zip file creation The correct values are held in a data descriptor immediately following the compressed data.
Bit 4: Reserved for use by PKZIP for enhanced deflating
Bit 5: If set indicates the file contains compressed patch data
Bit 6: If set indicates strong encryption was used.
Bit 7-10: Unused or reserved
Bit 11: If set the name and comments for this entry are in unicode.
Bit 12-15: Unused or reserved
 Get/Set index of this entry in Zip file This is only valid when the entry is part of a Get/set offset for use in central header Get/Set external file attributes as an integer. The values of this are operating system dependant see HostSystem for details Get the version made by for this entry or zero if unknown. The value / 10 indicates the major version number, and the value mod 10 is the minor version number Get a value indicating this entry is for a DOS/Windows system. Test the external attributes for this to see if the external attributes are Dos based (including WINNT and variants) and match the values The attributes to test. Returns true if the external attributes are known to be DOS/Windows based and have the same attributes set as the value passed. Gets the compatability information for the external file attribute If the external file attributes are compatible with MS-DOS and can be read by PKZIP for DOS version 2.04g then this value will be zero. Otherwise the value will be non-zero and identify the host system on which the attributes are compatible. The values for this as defined in the Zip File format and by others are shown below. The values are somewhat misleading in some cases as they are not all used as shown. You should consult the relevant documentation to obtain up to date and correct information. The modified appnote by the infozip group is particularly helpful as it documents a lot of peculiarities. The document is however a little dated. 0 - MS-DOS and OS/2 (FAT / VFAT / FAT32 file systems) 1 - Amiga 2 - OpenVMS 3 - Unix 4 - VM/CMS 5 - Atari ST 6 - OS/2 HPFS 7 - Macintosh 8 - Z-System 9 - CP/M 10 - Windows NTFS 11 - MVS (OS/390 - Z/OS) 12 - VSE 13 - Acorn Risc 14 - VFAT 15 - Alternate MVS 16 - BeOS 17 - Tandem 18 - OS/400 19 - OS/X (Darwin) 99 - WinZip AES remainder - unused Get minimum Zip feature version required to extract this entry Minimum features are defined as:
1.0 - Default value
1.1 - File is a volume label
2.0 - File is a folder/directory
2.0 - File is compressed using Deflate compression
2.0 - File is encrypted using traditional encryption
2.1 - File is compressed using Deflate64
2.5 - File is compressed using PKWARE DCL Implode
2.7 - File is a patch data set
4.5 - File uses Zip64 format extensions
4.6 - File is compressed using BZIP2 compression
5.0 - File is encrypted using DES
5.0 - File is encrypted using 3DES
5.0 - File is encrypted using original RC2 encryption
5.0 - File is encrypted using RC4 encryption
5.1 - File is encrypted using AES encryption
5.1 - File is encrypted using corrected RC2 encryption
5.1 - File is encrypted using corrected RC2-64 encryption
6.1 - File is encrypted using non-OAEP key wrapping
6.2 - Central directory encryption (not confirmed yet)
6.3 - File is compressed using LZMA
6.3 - File is compressed using PPMD+
6.3 - File is encrypted using Blowfish
6.3 - File is encrypted using Twofish
 Get a value indicating whether this entry can be decompressed by the library. This is based on the and wether the compression method is supported. Force this entry to be recorded using Zip64 extensions. Get a value indicating wether Zip64 extensions were forced. A value of true if Zip64 extensions have been forced on; false if not. Gets a value indicating if the entry requires Zip64 extensions to store the full entry values. A value of true if a local header requires Zip64 extensions; false if not. Get a value indicating wether the central directory entry requires Zip64 extensions to be stored. Get/Set DosTime value. The MS-DOS date format can only represent dates between 1/1/1980 and 12/31/2107. Gets/Sets the time of last modification of the entry. The property is updated to match this as far as possible. Returns the entry name. The unix naming convention is followed. Path components in the entry should always separated by forward slashes ('/'). Dos device names like C: should also be removed. See the class, or Gets/Sets the size of the uncompressed data. The size or -1 if unknown. Setting the size before adding an entry to an archive can help avoid compatability problems with some archivers which dont understand Zip64 extensions. Gets/Sets the size of the compressed data. The compressed entry size or -1 if unknown. Gets/Sets the crc of the uncompressed data. Crc is not in the range 0..0xffffffffL The crc value or -1 if unknown. Gets/Sets the compression method. Only Deflated and Stored are supported. The compression method for this entry Gets the compression method for outputting to the local or central header. Returns same value as CompressionMethod except when AES encrypting, which places 99 in the method and places the real method in the extra data. Gets/Sets the extra data. Extra data is longer than 64KB (0xffff) bytes. Extra data or null if not set. For AES encrypted files returns or sets the number of bits of encryption (128, 192 or 256). When setting, only 0 (off), 128 or 256 is supported. AES Encryption strength for storage in extra data in entry header. 1 is 128 bit, 2 is 192 bit, 3 is 256 bit. Returns the length of the salt, in bytes Number of extra bytes required to hold the AES Header fields (Salt, Pwd verify, AuthCode) Process extra data fields updating the entry based on the contents. True if the extra data fields should be handled for a local header, rather than for a central header. Gets/Sets the entry comment. If comment is longer than 0xffff. The comment or null if not set. A comment is only available for entries when read via the class. The class doesnt have the comment data available. Gets a value indicating if the entry is a directory. however. A directory is determined by an entry name with a trailing slash '/'. The external file attributes can also indicate an entry is for a directory. Currently only dos/windows attributes are tested in this manner. The trailing slash convention should always be followed. Get a value of true if the entry appears to be a file; false otherwise This only takes account of DOS/Windows attributes. Other operating systems are ignored. For linux and others the result may be incorrect. Test entry to see if data can be extracted. Returns true if data can be extracted for this entry; false otherwise. Creates a copy of this zip entry. An that is a copy of the current instance. Gets a string representation of this ZipEntry. A readable textual representation of this Test a compression method to see if this library supports extracting data compressed with that method The compression method to test. Returns true if the compression method is supported; false otherwise Cleans a name making it conform to Zip file conventions. Devices names ('c:\') and UNC share names ('\\server\share') are removed and forward slashes ('\') are converted to back slashes ('/'). Names are made relative by trimming leading slashes which is compatible with the ZIP naming convention. The name to clean The 'cleaned' name. The Zip name transform class is more flexible. Event arguments for scanning. Initialise a new instance of The file or directory name. The file or directory name for this event. Get set a value indicating if scanning should continue or not. Event arguments during processing of a single file or directory. Initialise a new instance of The file or directory name if known. The number of bytes processed so far The total number of bytes to process, 0 if not known The name for this event if known. Get set a value indicating wether scanning should continue or not. Get a percentage representing how much of the has been processed 0.0 to 100.0 percent; 0 if target is not known. The number of bytes processed so far The number of bytes to process. Target may be 0 or negative if the value isnt known. Event arguments for directories. Initialize an instance of . The name for this directory. Flag value indicating if any matching files are contained in this directory. Get a value indicating if the directory contains any matching files or not. Arguments passed when scan failures are detected. Initialise a new instance of The name to apply. The exception to use. The applicable name. The applicable exception. Get / set a value indicating wether scanning should continue. Delegate invoked before starting to process a directory. Delegate invoked before starting to process a file. The source of the event The event arguments. Delegate invoked during processing of a file or directory The source of the event The event arguments. Delegate invoked when a file has been completely processed. The source of the event The event arguments. Delegate invoked when a directory failure is detected. The source of the event The event arguments. Delegate invoked when a file failure is detected. The source of the event The event arguments. FileSystemScanner provides facilities scanning of files and directories. Initialise a new instance of The file filter to apply when scanning. Initialise a new instance of The file filter to apply. The directory filter to apply. Initialise a new instance of The file filter to apply. Initialise a new instance of The file filter to apply. The directory filter to apply. Delegate to invoke when a directory is processed. Delegate to invoke when a file is processed. Delegate to invoke when processing for a file has finished. Delegate to invoke when a directory failure is detected. Delegate to invoke when a file failure is detected. Raise the DirectoryFailure event. The directory name. The exception detected. Raise the FileFailure event. The file name. The exception detected. Raise the ProcessFile event. The file name. Raise the complete file event The file name Raise the ProcessDirectory event. The directory name. Flag indicating if the directory has matching files. Scan a directory. The base directory to scan. True to recurse subdirectories, false to scan a single directory. The file filter currently in use. The directory filter currently in use. Flag indicating if scanning should continue running. Provides simple " utilities. Read from a ensuring all the required data is read. The stream to read. The buffer to fill. Read from a " ensuring all the required data is read. The stream to read data from. The buffer to store data in. The offset at which to begin storing data. The number of bytes of data to store. Required parameter is null and or are invalid. End of stream is encountered before all the data has been read. Copy the contents of one to another. The stream to source data from. The stream to write data to. The buffer to use during copying. Copy the contents of one to another. The stream to source data from. The stream to write data to. The buffer to use during copying. The progress handler delegate to use. The minimum between progress updates. The source for this event. The name to use with the event. This form is specialised for use within #Zip to support events during archive operations. Copy the contents of one to another. The stream to source data from. The stream to write data to. The buffer to use during copying. The progress handler delegate to use. The minimum between progress updates. The source for this event. The name to use with the event. A predetermined fixed target value to use with progress updates. If the value is negative the target is calculated by looking at the stream. This form is specialised for use within #Zip to support events during archive operations. Initialise an instance of PathFilter filters directories and files using a form of regular expressions by full path name. See NameFilter for more detail on filtering. Initialise a new instance of . The filter expression to apply. Test a name to see if it matches the filter. The name to test. True if the name matches, false otherwise. is used to get the full path before matching. ExtendedPathFilter filters based on name, file size, and the last write time of the file. Provides an example of how to customise filtering. Initialise a new instance of ExtendedPathFilter. The filter to apply. The minimum file size to include. The maximum file size to include. Initialise a new instance of ExtendedPathFilter. The filter to apply. The minimum to include. The maximum to include. Initialise a new instance of ExtendedPathFilter. The filter to apply. The minimum file size to include. The maximum file size to include. The minimum to include. The maximum to include. Test a filename to see if it matches the filter. The filename to test. True if the filter matches, false otherwise. The doesnt exist Get/set the minimum size/length for a file that will match this filter. The default value is zero. value is less than zero; greater than Get/set the maximum size/length for a file that will match this filter. The default value is value is less than zero or less than Get/set the minimum value that will match for this filter. Files with a LastWrite time less than this value are excluded by the filter. Get/set the maximum value that will match for this filter. Files with a LastWrite time greater than this value are excluded by the filter. NameAndSizeFilter filters based on name and file size. A sample showing how filters might be extended. Initialise a new instance of NameAndSizeFilter. The filter to apply. The minimum file size to include. The maximum file size to include. Test a filename to see if it matches the filter. The filename to test. True if the filter matches, false otherwise. Get/set the minimum size for a file that will match this filter. Get/set the maximum size for a file that will match this filter. NameFilter is a string matching class which allows for both positive and negative matching. A filter is a sequence of independant regular expressions separated by semi-colons ';'. To include a semi-colon it may be quoted as in \;. Each expression can be prefixed by a plus '+' sign or a minus '-' sign to denote the expression is intended to include or exclude names. If neither a plus or minus sign is found include is the default. A given name is tested for inclusion before checking exclusions. Only names matching an include spec and not matching an exclude spec are deemed to match the filter. An empty filter matches any name. The following expression includes all name ending in '.dat' with the exception of 'dummy.dat' "+\.dat$;-^dummy\.dat$" Construct an instance based on the filter expression passed The filter expression. Test a string to see if it is a valid regular expression. The expression to test. True if expression is a valid false otherwise. Test an expression to see if it is valid as a filter. The filter expression to test. True if the expression is valid, false otherwise. Split a string into its component pieces The original string Returns an array of values containing the individual filter elements. Convert this filter to its string equivalent. The string equivalent for this filter. Test a value to see if it is included by the filter. The value to test. True if the value is included, false otherwise. Test a value to see if it is excluded by the filter. The value to test. True if the value is excluded, false otherwise. Test a value to see if it matches the filter. The value to test. True if the value matches, false otherwise. Compile this filter. Scanning filters support filtering of names. Test a name to see if it 'matches' the filter. The name to test. Returns true if the name matches the filter, false if it does not match. WindowsPathUtils provides simple utilities for handling windows paths. Initializes a new instance of the class. Remove any path root present in the path A containing path information. The path with the root removed if it was present; path otherwise. Unlike the class the path isnt otherwise checked for validity. INameTransform defines how file system names are transformed for use with archives, or vice versa. Given a file name determine the transformed value. The name to transform. The transformed file name. Given a directory name determine the transformed value. The name to transform. The transformed directory name PkzipClassic embodies the classic or original encryption facilities used in Pkzip archives. While it has been superceded by more recent and more powerful algorithms, its still in use and is viable for preventing casual snooping Generates new encryption keys based on given seed The seed value to initialise keys with. A new key value. PkzipClassicCryptoBase provides the low level facilities for encryption and decryption using the PkzipClassic algorithm. Transform a single byte The transformed value Set the key schedule for encryption/decryption. The data use to set the keys from. Update encryption keys Reset the internal state. PkzipClassic CryptoTransform for encryption. Initialise a new instance of The key block to use. Transforms the specified region of the specified byte array. The input for which to compute the transform. The offset into the byte array from which to begin using data. The number of bytes in the byte array to use as data. The computed transform. Transforms the specified region of the input byte array and copies the resulting transform to the specified region of the output byte array. The input for which to compute the transform. The offset into the input byte array from which to begin using data. The number of bytes in the input byte array to use as data. The output to which to write the transform. The offset into the output byte array from which to begin writing data. The number of bytes written. Gets a value indicating whether the current transform can be reused. Gets the size of the input data blocks in bytes. Gets the size of the output data blocks in bytes. Gets a value indicating whether multiple blocks can be transformed. Cleanup internal state. PkzipClassic CryptoTransform for decryption. Initialise a new instance of . The key block to decrypt with. Transforms the specified region of the specified byte array. The input for which to compute the transform. The offset into the byte array from which to begin using data. The number of bytes in the byte array to use as data. The computed transform. Transforms the specified region of the input byte array and copies the resulting transform to the specified region of the output byte array. The input for which to compute the transform. The offset into the input byte array from which to begin using data. The number of bytes in the input byte array to use as data. The output to which to write the transform. The offset into the output byte array from which to begin writing data. The number of bytes written. Gets a value indicating whether the current transform can be reused. Gets the size of the input data blocks in bytes. Gets the size of the output data blocks in bytes. Gets a value indicating whether multiple blocks can be transformed. Cleanup internal state. Defines a wrapper object to access the Pkzip algorithm. This class cannot be inherited. Get / set the applicable block size in bits. The only valid block size is 8. Get an array of legal key sizes. Generate an initial vector. Get an array of legal block sizes. Get / set the key value applicable. Generate a new random key. Create an encryptor. The key to use for this encryptor. Initialisation vector for the new encryptor. Returns a new PkzipClassic encryptor Create a decryptor. Keys to use for this new decryptor. Initialisation vector for the new decryptor. Returns a new decryptor. Encrypts and decrypts AES ZIP Constructor The stream on which to perform the cryptographic transformation. Instance of ZipAESTransform Read or Write Reads a sequence of bytes from the current CryptoStream into buffer, and advances the position within the stream by the number of bytes read. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. An array of bytes. This method copies count bytes from buffer to the current stream. The byte offset in buffer at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. Transforms stream using AES in CTR mode Constructor. Password string Random bytes, length depends on encryption strength. 128 bits = 8 bytes, 192 bits = 12 bytes, 256 bits = 16 bytes. The encryption strength, in bytes eg 16 for 128 bits. True when creating a zip, false when reading. For the AuthCode. Implement the ICryptoTransform method. Returns the 2 byte password verifier Returns the 10 byte AUTH CODE to be checked or appended immediately following the AES data stream. Not implemented. Gets the size of the input data blocks in bytes. Gets the size of the output data blocks in bytes. Gets a value indicating whether multiple blocks can be transformed. Gets a value indicating whether the current transform can be reused. Cleanup internal state. easy timer impl cancel timer delay in period get which endpoint to send get error in sending get reply wait until got return message timeout in milliseconds get ack message get where the ack message come from endpoint's id logic endpoint local proxy object get id known by both side, like a sessionId check is there any sender can be used to send send message and wait reply send message and wait reply timeout in milliseconds send message and wait reply use to send, must belong this proxy timeout in milliseconds send message send message use to send, must belong this proxy simple id with Name get or set clientChannelSelector message received, see RTT based ack message received, see RTT based get id get connected endpoint by id connect endpoint target id target address connect endpoint target id target address passed as connect message context for receiving message get received message get where the message sent from reply message tell error occur for endpoints talking deal with protocol/callback/send zip helper compatible with java version a channel pool that same uri sharing same channel get or set heartbeat interval time in milliseconds the channel that can send message to client weather channel is open get channel context by given object key, channel conext can be used to store something that belong itself set channel context by given object key, channel conext can be used to store something that belong itself a channel used to sending message send bytes close channel with given reason the channel that can send message to client via raw tcp server channel bind on raw tcp, just impl an easy server init tcp server channel deal with networkstream the channel that client connect to server while message received on this channel while error occur on this channel while channel was closed by given reason get or set remote uri weather the channel is valid timer for heartbeat if set channel holder/pool that switch channel by uri.scheme get channel return channel websocket clientchannel via websocket-sharp impl simple websocket client helper connect to uri via websocket remote address timeout in milliseconds connect to uri via websocket loggerFactory remote address timeout in milliseconds context used with channel event error from channel the channel used to sending message received message send data to channel where the message come from the channel that server bound get server address get or set connection max idle time that do not send or receive while message received on this channel while error occur on this channel start server stop server channel closed reason get reason why closed Decodes an HTML-encoded string and returns the decoded string. The HTML string to decode. The decoded text. Decodes an HTML-encoded string and sends the resulting output to a TextWriter output stream. The HTML string to decode. The TextWriter output stream containing the decoded string. HTML-encodes a string and returns the encoded string. The text string to encode. The HTML-encoded text. HTML-encodes a string and sends the resulting output to a TextWriter output stream. The string to encode. The TextWriter output stream containing the encoded string. Provides a set of static methods for the websocket-sharp. Accept a WebSocket connection by the . A that contains a WebSocket connection. A that contains a TCP connection to accept a WebSocket connection from. A that indicates a secure connection or not. (true indicates a secure connection.) Is thrown when the parameter passed to a method is invalid because it is . Emit the specified delegate if is not . An to emit. An that emits the . An that contains no event data. Emit the specified delegate if is not . An to emit. An that emits the . An that contains the event data. The type of the event data generated by the event. Determines whether the specified equals the specified as . And save this specified as to the specified . true if the parameter equals the parameter as ; otherwise, false. An to compare. A to compare. A to save the as . Is thrown when the parameter passed to a method is invalid because it is outside the allowable range of values as . Determines whether the entry with the specified key exists in the specified . true if the entry with the exists in the ; otherwise, false. A that contains the entries. A that contains the key of the entry to find. Determines whether the entry with the specified both key and value exists in the specified . true if the entry with the both and exists in the ; otherwise, false. A that contains the entries. A that contains the key of the entry to find. A that contains the value of the entry to find. Gets the absolute path from the specified . A that contains the absolute path if got successfully; otherwise, . A that contains the URI to get the absolute path from. Gets the description of the HTTP status code using the specified code. A that contains the description of the . One of values that contains the HTTP status code. Gets the name from the specified that contains a pair of name and value are separated by a separator string. A that contains the name if any; otherwise, null. A that contains a pair of name and value are separated by a separator string. A that contains a separator string. Gets the name and value from the specified that contains a pair of name and value are separated by a separator string. A that contains the name and value if any. A that contains a pair of name and value are separated by a separator string. A that contains a separator string. Gets the description of the HTTP status code using the specified code. A that contains the description of the . An that contains the HTTP status code. Gets the value from the specified that contains a pair of name and value are separated by a separator string. A that contains the value if any; otherwise, null. A that contains a pair of name and value are separated by a separator string. A that contains a separator string. Determines whether the specified is a . true if the parameter is a ; otherwise, false. A to test. Determines whether the specified is host (this computer architecture) byte order. true if the parameter is host byte order; otherwise, false. A to test. Determines whether the specified object is . true if the parameter is ; otherwise, false. A to test. The type of the parameter. Determines whether the specified object is . And invokes the specified delegate if the specified object is . true if the parameter is ; otherwise, false. A to test. An delegate that contains the method(s) called if the is . The type of the parameter. Determines whether the specified is or . true if the parameter is or ; otherwise, false. A to test. Determines whether the specified is predefined scheme. true if the parameter is the predefined scheme; otherwise, false. A to test. Determines whether the specified is valid absolute path. true if the parameter is valid absolute path; otherwise, false. A to test. A that receives a message if the is invalid. Determines whether the specified is a URI string. true if the parameter is maybe a URI string; otherwise, false. A to test. Determines whether two specified objects don't have the same value. true if the value of parameter isn't the same as the value of parameter; otherwise, false. The first to compare. The second to compare. A that indicates a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.) Reads a block of bytes from the specified stream and returns the read data in an array of . An array of that receives the read data. A that contains the data to read. An that contains the number of bytes to read. Reads a block of bytes from the specified stream and returns the read data in an array of . An array of that receives the read data. A that contains the data to read. A that contains the number of bytes to read. Reads a block of bytes from the specified stream and returns the read data in an array of . An array of that receives the read data. A that contains the data to read. A that contains the number of bytes to read. An that contains the buffer size in bytes of each internal read. Retrieves a sub-array from the specified . A sub-array starts at the specified element position. An array of T that receives a sub-array, or an empty array of T if any problems with the parameters. An array of T that contains the data to retrieve a sub-array. An that contains the zero-based starting position of a sub-array in the . An that contains the number of elements to retrieve a sub-array. The type of elements in the . Executes the specified delegate times. An that contains the number of times to execute. An delegate that contains the method(s) to execute. Executes the specified delegate times. A that contains the number of times to execute. An delegate that contains the method(s) to execute. Executes the specified delegate times. A that contains the number of times to execute. An delegate that contains the method(s) to execute. Executes the specified delegate times. A that contains the number of times to execute. An delegate that contains the method(s) to execute. Executes the specified delegate times. An that contains the number of times to execute. An delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration. Executes the specified delegate times. A that contains the number of times to execute. An delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration. Executes the specified delegate times. A that contains the number of times to execute. An delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration. Executes the specified delegate times. A that contains the number of times to execute. An delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration. Converts the specified array of to the specified type data. A T converted from the , or a default value of T if the is an empty array of or if the types of T aren't the , , , , , , , , , . An array of to convert. A that indicates the byte order of the . The type of the return value. The T must be a value type. Is thrown when the parameter passed to a method is invalid because it is . Converts the specified data to an array of . An array of converted from the . A T to convert. A that indicates the byte order of the return. The type of the . The T must be a value type. Converts the order of the specified array of to the host byte order. An array of converted from the . An array of to convert. A that indicates the byte order of the . Is thrown when the parameter passed to a method is invalid because it is . Converts the specified array to a concatenated the specified separator string between each element of this array. A converted from the parameter, or a if the length of the is zero. An array of T to convert. A that contains a separator string. The type of elements in the . Is thrown when the parameter passed to a method is invalid because it is . Converts the specified to a object. A converted from the parameter, or if the is or . A to convert. Tries to create a new WebSocket using the specified . true if the WebSocket was successfully created; otherwise, false. A that contains a WebSocket URI. When this method returns, contains a created WebSocket if the parameter is valid WebSocket URI; otherwise, . When this method returns, contains a error message if the parameter is invalid WebSocket URI; otherwise, String.Empty. Is thrown when the parameter passed to a method is invalid because it is . URL-decodes the specified . A that receives a decoded string, or the parameter if the is or . A to decode. URL-encodes the specified . A that receives a encoded string, or the parameter if the is or . A to encode. Writes the specified content data using the specified . A that contains a network stream to write a content data. An array of that contains a content data to write. Is thrown when the parameter passed to a method is invalid because it is . Implements the WebSocket interface. The WebSocket class provides methods and properties for two-way communication using the WebSocket protocol (RFC 6455). Initializes a new instance of the class with the specified WebSocket URL and subprotocols. A that contains the WebSocket URL. An array of that contains the WebSocket subprotocols if any. is . is not valid WebSocket URL. Initializes a new instance of the class with the specified WebSocket URL, OnOpen, OnMessage, OnError, OnClose event handlers and subprotocols. A that contains the WebSocket URL. An OnOpen event handler. An OnMessage event handler. An OnError event handler. An OnClose event handler. An array of that contains the WebSocket subprotocols if any. is . is not valid WebSocket URL. Gets the amount of untransmitted data. The number of bytes of untransmitted data. Gets the extensions selected by the server. A that contains the extensions if any. By default, String.Empty. (Currently this will only ever be the String.Empty.) Gets a value indicating whether a connection is alive. true if the connection is alive; otherwise, false. Gets a value indicating whether a connection is secure. true if the connection is secure; otherwise, false. Gets the subprotocol selected by the server. A that contains the subprotocol if any. By default, String.Empty. Gets the state of the connection. A . By default, WsState.CONNECTING. Gets the untransmitted WebSocket frames. A IList<WsFrame> that contains the untransmitted WebSocket frames. Gets or sets the WebSocket URL. A that contains the WebSocket URL. Gets or sets the WebSocket Origin. Gets or sets the extra WebSocket handshake headers. Occurs when the WebSocket connection has been established. Occurs when the WebSocket receives a data frame. Occurs when the WebSocket gets an error. Occurs when the WebSocket receives a Close frame or the Close method is called. Closes the connection and releases all associated resources after sends a Close control frame. Closes the connection and releases all associated resources after sends a Close control frame. A that contains a status code indicating a reason for closure. Closes the connection and releases all associated resources after sends a Close control frame. A that contains a status code indicating a reason for closure. Closes the connection and releases all associated resources after sends a Close control frame. A that contains a status code indicating a reason for closure. A that contains a reason for closure. Closes the connection and releases all associated resources after sends a Close control frame. A that contains a status code indicating a reason for closure. A that contains a reason for closure. Establishes a connection. Closes the connection and releases all associated resources after sends a Close control frame. Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. Sends a Ping frame using the connection. true if the WebSocket receives a Pong frame in a time; otherwise, false. Sends a Ping frame with a message using the connection. A that contains the message to be sent. true if the WebSocket receives a Pong frame in a time; otherwise, false. Sends a text data using the connection. A that contains the text data to be sent. Sends a binary data using the connection. An array of that contains the binary data to be sent. Sends a binary data using the connection. A that contains the binary data to be sent. Sends a text data asynchronously using the connection. A that contains the text data to be sent. An delegate that contains the method(s) that is called when an asynchronous operation completes. Sends a binary data asynchronously using the connection. An array of that contains the binary data to be sent. An delegate that contains the method(s) that is called when an asynchronous operation completes. Sends a binary data asynchronously using the connection. A that contains the binary data to be sent. An delegate that contains the method(s) that is called when an asynchronous operation completes. .Net Remoting Protocol (via HTTP) Parser eg: POST /remote.rem HTTP/1.1 http request first line, eg: POST /remote.rem HTTP/1.1 GET/POST http response first line, eg: HTTP/1.1 200 ok read all http headers write http headers .Net Remoting Protocol stream read/write read message content by content-length write serialized message content by content-length .Net Remoting Protocol (via TCP) Parser remoting protocol premable, expected value is ".NET". remoting protocol majorVersion, expected value is "1". remoting protocol minorVersion, expected value is "0". remoting operation code, eg Request/OneWayRequest/Reply write remoting operation code Request/OneWayRequest/Reply Chunked or Fixed ContentLength. Only http channel support currently. ContentLength=0, Chunked=1 get message content length write transport header. PS: "RequestUri" must be transport while request call remoting message header define Use the optimized fast Dataset Schema format (default = True) Use the fast GUID format (default = True) Serialize null values to the output (default = True) Use the UTC date format (default = True) Show the readonly properties of types in the output (default = False) Use the $types extension to optimise the output json (default = True) Ignore case when processing json and deserializing Anonymous types have read only properties Enable fastJSON extensions $types, $type, $map (default = True) Use escaped unicode i.e. \uXXXX format for non ASCII characters (default = True) Output string key dictionaries as "k"/"v" format (default = False) Output Enum values instead of names (default = False) Ignore attributes to check for (default : XmlIgnoreAttribute) If you have parametric and no default constructor for you classes (default = False) IMPORTANT NOTE : If True then all initial values within the class will be ignored and will be not set Serialize DateTime milliseconds i.e. yyyy-MM-dd HH:mm:ss.nnn (default = false) Maximum depth for circular references in inline mode (default = 20) Inline circular or already seen objects instead of replacement with $i (default = False) Save property/field names as lowercase (default = false) Serialize property name with underline style Globally set-able parameters for controlling the serializer Create a formatted json string (beautified) from an object Create a json representation for an object Create a json representation for an object with parameter override on this call Parse a json string and generate a Dictionary<string,object> or List<object> structure Create a typed generic object from the json Create a typed generic object from the json with parameter override on this call Create an object from the json Create an object from the json with parameter override on this call Create an object of type from the json Fill a given object with the json represenation Deep copy an object i.e. clone to a new object Create a human readable string from the json Register custom type handlers for your own types not natively handled by fastJSON Clear the internal reflection cache so you can start from new (you will loose performance) This class encodes and decodes JSON strings. Spec. details, see http://www.json.org/ TOP请求接口。 获取TOP的API名称。 API名称 获取所有的Key-Value形式的文本请求参数字典。其中： Key: 请求参数名 Value: 请求参数文本值 文本请求参数字典 提前验证参数。 基于REST的阿里云客户端。 请求与响应的超时时间 执行HTTP POST请求。 请求地址 请求参数 HTTP响应 执行HTTP GET请求。 请求地址 请求参数 HTTP响应 执行带文件上传的HTTP POST请求。 请求地址 请求文本参数 请求文件参数 HTTP响应 把响应流转换为文本。 响应流对象 编码方式 响应文本 组装GET请求URL。 请求地址 请求参数 带参数的GET请求URL 组装普通文本请求参数。 Key-Value形式请求参数字典 URL编码后的请求数据 TOP JSON响应通用解释器。 TOP JSON响应通用读取器。 TOP XML响应通用解释器。 获取XML响应的根节点名称 TOP API响应解释器接口。响应格式可以是XML, JSON等等。 把响应字符串解释成相应的领域对象。 领域对象 响应字符串 领域对象 TOP上传请求接口，支持同时上传多个文件。 获取所有的Key-Value形式的文件请求参数字典。其中： Key: 请求参数名 Value: 文件对象 文件请求参数字典 TOP客户端。 执行TOP公开API请求。 领域对象 具体的TOP API请求 领域对象 执行TOP隐私API请求。 领域对象 具体的TOP API请求 用户会话码 领域对象 执行TOP隐私API请求。 领域对象 具体的TOP API请求 用户会话码 请求时间戳 领域对象 错误码 错误信息 响应原始内容 响应结果是否错误 奇门客户端。 执行奇门公开API请求。 领域对象 具体的奇门API请求 领域对象 执行奇门隐私API请求。 领域对象 具体的奇门API请求 用户会话码 领域对象 自定义URL参数 客户ID号 请求时间戳 API版本号 测试类型 请求body体 获取API名称 基于REST的TOP客户端。 TOP客户端。 执行TOP公开API请求。 领域对象 具体的TOP API请求 领域对象 执行TOP隐私API请求。 领域对象 具体的TOP API请求 用户会话码 领域对象 执行TOP隐私API请求。 领域对象 具体的TOP API请求 用户会话码 请求时间戳 领域对象 基础TOP请求类，存放一些通用的请求参数。 HTTP请求URL参数 HTTP请求头参数 TOP请求接口。 获取TOP的API名称。 获取所有的Key-Value形式的文本请求参数字典。 获取自定义HTTP请求头参数。 客户端参数检查，减少服务端无效调用。