protobuf-net.xml 82 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>protobuf-net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ProtoBuf.Extensible">
  8. <summary>
  9. Simple base class for supporting unexpected fields allowing
  10. for loss-less round-tips/merge, even if the data is not understod.
  11. The additional fields are (by default) stored in-memory in a buffer.
  12. </summary>
  13. <remarks>As an example of an alternative implementation, you might
  14. choose to use the file system (temporary files) as the back-end, tracking
  15. only the paths [such an object would ideally be IDisposable and use
  16. a finalizer to ensure that the files are removed].</remarks>
  17. <seealso cref="T:ProtoBuf.IExtensible"/>
  18. </member>
  19. <member name="T:ProtoBuf.IExtensible">
  20. <summary>
  21. Indicates that the implementing type has support for protocol-buffer
  22. <see cref="T:ProtoBuf.IExtension">extensions</see>.
  23. </summary>
  24. <remarks>Can be implemented by deriving from <see cref="T:ProtoBuf.Extensible"/>.</remarks>
  25. </member>
  26. <member name="M:ProtoBuf.IExtensible.GetExtensionObject(System.Boolean)">
  27. <summary>
  28. Retrieves the <see cref="T:ProtoBuf.IExtension">extension</see> object for the current
  29. instance, optionally creating it if it does not already exist.
  30. </summary>
  31. <param name="createIfMissing">Should a new extension object be
  32. created if it does not already exist?</param>
  33. <returns>The extension object if it exists (or was created), or null
  34. if the extension object does not exist or is not available.</returns>
  35. <remarks>The <c>createIfMissing</c> argument is false during serialization,
  36. and true during deserialization upon encountering unexpected fields.</remarks>
  37. </member>
  38. <member name="M:ProtoBuf.Extensible.GetExtensionObject(System.Boolean)">
  39. <summary>
  40. Retrieves the <see cref="T:ProtoBuf.IExtension">extension</see> object for the current
  41. instance, optionally creating it if it does not already exist.
  42. </summary>
  43. <param name="createIfMissing">Should a new extension object be
  44. created if it does not already exist?</param>
  45. <returns>The extension object if it exists (or was created), or null
  46. if the extension object does not exist or is not available.</returns>
  47. <remarks>The <c>createIfMissing</c> argument is false during serialization,
  48. and true during deserialization upon encountering unexpected fields.</remarks>
  49. </member>
  50. <member name="M:ProtoBuf.Extensible.GetExtensionObject(ProtoBuf.IExtension@,System.Boolean)">
  51. <summary>
  52. Provides a simple, default implementation for <see cref="T:ProtoBuf.IExtension">extension</see> support,
  53. optionally creating it if it does not already exist. Designed to be called by
  54. classes implementing <see cref="T:ProtoBuf.IExtensible"/>.
  55. </summary>
  56. <param name="createIfMissing">Should a new extension object be
  57. created if it does not already exist?</param>
  58. <param name="extensionObject">The extension field to check (and possibly update).</param>
  59. <returns>The extension object if it exists (or was created), or null
  60. if the extension object does not exist or is not available.</returns>
  61. <remarks>The <c>createIfMissing</c> argument is false during serialization,
  62. and true during deserialization upon encountering unexpected fields.</remarks>
  63. </member>
  64. <member name="M:ProtoBuf.Extensible.AppendValue``1(ProtoBuf.IExtensible,System.Int32,``0)">
  65. <summary>
  66. Appends the value as an additional (unexpected) data-field for the instance.
  67. Note that for non-repeated sub-objects, this equates to a merge operation;
  68. for repeated sub-objects this adds a new instance to the set; for simple
  69. values the new value supercedes the old value.
  70. </summary>
  71. <remarks>Note that appending a value does not remove the old value from
  72. the stream; avoid repeatedly appending values for the same field.</remarks>
  73. <typeparam name="TValue">The type of the value to append.</typeparam>
  74. <param name="instance">The extensible object to append the value to.</param>
  75. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  76. <param name="value">The value to append.</param>
  77. </member>
  78. <member name="M:ProtoBuf.Extensible.AppendValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,``0)">
  79. <summary>
  80. Appends the value as an additional (unexpected) data-field for the instance.
  81. Note that for non-repeated sub-objects, this equates to a merge operation;
  82. for repeated sub-objects this adds a new instance to the set; for simple
  83. values the new value supercedes the old value.
  84. </summary>
  85. <remarks>Note that appending a value does not remove the old value from
  86. the stream; avoid repeatedly appending values for the same field.</remarks>
  87. <typeparam name="TValue">The data-type of the field.</typeparam>
  88. <param name="format">The data-format to use when encoding the value.</param>
  89. <param name="instance">The extensible object to append the value to.</param>
  90. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  91. <param name="value">The value to append.</param>
  92. </member>
  93. <member name="M:ProtoBuf.Extensible.GetValue``1(ProtoBuf.IExtensible,System.Int32)">
  94. <summary>
  95. Queries an extensible object for an additional (unexpected) data-field for the instance.
  96. The value returned is the composed value after merging any duplicated content; if the
  97. value is "repeated" (a list), then use GetValues instead.
  98. </summary>
  99. <typeparam name="TValue">The data-type of the field.</typeparam>
  100. <param name="instance">The extensible object to obtain the value from.</param>
  101. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  102. <returns>The effective value of the field, or the default value if not found.</returns>
  103. </member>
  104. <member name="M:ProtoBuf.Extensible.GetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
  105. <summary>
  106. Queries an extensible object for an additional (unexpected) data-field for the instance.
  107. The value returned is the composed value after merging any duplicated content; if the
  108. value is "repeated" (a list), then use GetValues instead.
  109. </summary>
  110. <typeparam name="TValue">The data-type of the field.</typeparam>
  111. <param name="instance">The extensible object to obtain the value from.</param>
  112. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  113. <param name="format">The data-format to use when decoding the value.</param>
  114. <returns>The effective value of the field, or the default value if not found.</returns>
  115. </member>
  116. <member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,``0@)">
  117. <summary>
  118. Queries an extensible object for an additional (unexpected) data-field for the instance.
  119. The value returned (in "value") is the composed value after merging any duplicated content;
  120. if the value is "repeated" (a list), then use GetValues instead.
  121. </summary>
  122. <typeparam name="TValue">The data-type of the field.</typeparam>
  123. <param name="value">The effective value of the field, or the default value if not found.</param>
  124. <param name="instance">The extensible object to obtain the value from.</param>
  125. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  126. <returns>True if data for the field was present, false otherwise.</returns>
  127. </member>
  128. <member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,``0@)">
  129. <summary>
  130. Queries an extensible object for an additional (unexpected) data-field for the instance.
  131. The value returned (in "value") is the composed value after merging any duplicated content;
  132. if the value is "repeated" (a list), then use GetValues instead.
  133. </summary>
  134. <typeparam name="TValue">The data-type of the field.</typeparam>
  135. <param name="value">The effective value of the field, or the default value if not found.</param>
  136. <param name="instance">The extensible object to obtain the value from.</param>
  137. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  138. <param name="format">The data-format to use when decoding the value.</param>
  139. <returns>True if data for the field was present, false otherwise.</returns>
  140. </member>
  141. <member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,``0@)">
  142. <summary>
  143. Queries an extensible object for an additional (unexpected) data-field for the instance.
  144. The value returned (in "value") is the composed value after merging any duplicated content;
  145. if the value is "repeated" (a list), then use GetValues instead.
  146. </summary>
  147. <typeparam name="TValue">The data-type of the field.</typeparam>
  148. <param name="value">The effective value of the field, or the default value if not found.</param>
  149. <param name="instance">The extensible object to obtain the value from.</param>
  150. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  151. <param name="format">The data-format to use when decoding the value.</param>
  152. <param name="allowDefinedTag">Allow tags that are present as part of the definition; for example, to query unknown enum values.</param>
  153. <returns>True if data for the field was present, false otherwise.</returns>
  154. </member>
  155. <member name="M:ProtoBuf.Extensible.GetValues``1(ProtoBuf.IExtensible,System.Int32)">
  156. <summary>
  157. Queries an extensible object for an additional (unexpected) data-field for the instance.
  158. Each occurrence of the field is yielded separately, making this usage suitable for "repeated"
  159. (list) fields.
  160. </summary>
  161. <remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
  162. <typeparam name="TValue">The data-type of the field.</typeparam>
  163. <param name="instance">The extensible object to obtain the value from.</param>
  164. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  165. <returns>An enumerator that yields each occurrence of the field.</returns>
  166. </member>
  167. <member name="M:ProtoBuf.Extensible.GetValues``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
  168. <summary>
  169. Queries an extensible object for an additional (unexpected) data-field for the instance.
  170. Each occurrence of the field is yielded separately, making this usage suitable for "repeated"
  171. (list) fields.
  172. </summary>
  173. <remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
  174. <typeparam name="TValue">The data-type of the field.</typeparam>
  175. <param name="instance">The extensible object to obtain the value from.</param>
  176. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  177. <param name="format">The data-format to use when decoding the value.</param>
  178. <returns>An enumerator that yields each occurrence of the field.</returns>
  179. </member>
  180. <member name="T:ProtoBuf.Serializer">
  181. <summary>
  182. Provides protocol-buffer serialization capability for concrete, attributed types.
  183. </summary>
  184. <remarks>
  185. Protocol-buffer serialization is a compact binary format, designed to take
  186. advantage of sparse data and knowledge of specific data types; it is also
  187. extensible, allowing a type to be deserialized / merged even if some data is
  188. not recognised.
  189. </remarks>
  190. </member>
  191. <member name="F:ProtoBuf.Serializer.ListItemTag">
  192. <summary>
  193. The implicit tag used when serializing lists and other enumerable data.
  194. </summary>
  195. </member>
  196. <member name="M:ProtoBuf.Serializer.TryGetTag(System.Reflection.MemberInfo,System.Int32@,System.String@,ProtoBuf.DataFormat@,ProtoBuf.MemberSerializationOptions@)">
  197. <summary>
  198. Supports various different property metadata patterns:
  199. [ProtoMember] is the most specific, allowing the data-format to be set.
  200. [DataMember], [XmlElement] are supported for compatibility.
  201. In any event, there must be a unique positive Tag/Order.
  202. </summary>
  203. </member>
  204. <member name="M:ProtoBuf.Serializer.Deserialize``1(System.IO.Stream)">
  205. <summary>
  206. Creates a new instance from a protocol-buffer stream
  207. </summary>
  208. <typeparam name="T">The type to be created.</typeparam>
  209. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  210. <returns>A new, initialized instance.</returns>
  211. </member>
  212. <member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream)">
  213. <summary>
  214. Creates a new instance from a protocol-buffer stream that has a length-prefix
  215. on data (to assist with network IO).
  216. </summary>
  217. <typeparam name="T">The type to be created.</typeparam>
  218. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  219. <returns>A new, initialized instance.</returns>
  220. </member>
  221. <member name="M:ProtoBuf.Serializer.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
  222. <summary>
  223. Reads a sequence of consecutive length-prefixed items from a stream, using
  224. either base-128 or fixed-length prefixes. Base-128 prefixes with a tag
  225. are directly comparable to serializing multiple items in succession
  226. (use the <see cref="F:ProtoBuf.Serializer.ListItemTag"/> tag to emulate the implicit behavior
  227. when serializing a list/array). When a tag is
  228. specified, any records with different tags are silently omitted. The
  229. tag is ignored. The tag is ignores for fixed-length prefixes.
  230. </summary>
  231. <typeparam name="T">The type of object to deserialize.</typeparam>
  232. <param name="source">The binary stream containing the serialized records.</param>
  233. <param name="style">The prefix style used in the data.</param>
  234. <param name="tag">The tag of records to return (if non-positive, then no tag is
  235. expected and all records are returned).</param>
  236. <returns>The sequence of deserialized objects.</returns>
  237. </member>
  238. <member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream,ProtoBuf.PrefixStyle)">
  239. <summary>
  240. Creates a new instance from a protocol-buffer stream that has a length-prefix
  241. on data (to assist with network IO).
  242. </summary>
  243. <typeparam name="T">The type to be created.</typeparam>
  244. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  245. <param name="style">How to encode the length prefix.</param>
  246. <returns>A new, initialized instance.</returns>
  247. </member>
  248. <member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
  249. <summary>
  250. Creates a new instance from a protocol-buffer stream that has a length-prefix
  251. on data (to assist with network IO).
  252. </summary>
  253. <typeparam name="T">The type to be created.</typeparam>
  254. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  255. <param name="style">How to encode the length prefix.</param>
  256. <param name="tag">The expected tag of the item (only used with base-128 prefix style).</param>
  257. <returns>A new, initialized instance.</returns>
  258. </member>
  259. <member name="M:ProtoBuf.Serializer.TryReadLengthPrefix(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32@)">
  260. <summary>Indicates the number of bytes expected for the next message.</summary>
  261. <param name="source">The stream containing the data to investigate for a length.</param>
  262. <param name="style">The algorithm used to encode the length.</param>
  263. <param name="length">The length of the message, if it could be identified.</param>
  264. <returns>True if a length could be obtained, false otherwise.</returns>
  265. </member>
  266. <member name="M:ProtoBuf.Serializer.TryReadLengthPrefix(System.Byte[],System.Int32,System.Int32,ProtoBuf.PrefixStyle,System.Int32@)">
  267. <summary>Indicates the number of bytes expected for the next message.</summary>
  268. <param name="buffer">The buffer containing the data to investigate for a length.</param>
  269. <param name="index">The offset of the first byte to read from the buffer.</param>
  270. <param name="count">The number of bytes to read from the buffer.</param>
  271. <param name="style">The algorithm used to encode the length.</param>
  272. <param name="length">The length of the message, if it could be identified.</param>
  273. <returns>True if a length could be obtained, false otherwise.</returns>
  274. </member>
  275. <member name="M:ProtoBuf.Serializer.Merge``1(System.IO.Stream,``0)">
  276. <summary>
  277. Applies a protocol-buffer stream to an existing instance.
  278. </summary>
  279. <typeparam name="T">The type being merged.</typeparam>
  280. <param name="instance">The existing instance to be modified (can be null).</param>
  281. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  282. <returns>The updated instance; this may be different to the instance argument if
  283. either the original instance was null, or the stream defines a known sub-type of the
  284. original instance.</returns>
  285. </member>
  286. <member name="M:ProtoBuf.Serializer.MergeWithLengthPrefix``1(System.IO.Stream,``0)">
  287. <summary>
  288. Applies a protocol-buffer stream to an existing instance, using length-prefixed
  289. data - useful with network IO.
  290. </summary>
  291. <typeparam name="T">The type being merged.</typeparam>
  292. <param name="instance">The existing instance to be modified (can be null).</param>
  293. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  294. <returns>The updated instance; this may be different to the instance argument if
  295. either the original instance was null, or the stream defines a known sub-type of the
  296. original instance.</returns>
  297. </member>
  298. <member name="M:ProtoBuf.Serializer.MergeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle)">
  299. <summary>
  300. Applies a protocol-buffer stream to an existing instance, using length-prefixed
  301. data - useful with network IO.
  302. </summary>
  303. <typeparam name="T">The type being merged.</typeparam>
  304. <param name="instance">The existing instance to be modified (can be null).</param>
  305. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  306. <param name="style">How to encode the length prefix.</param>
  307. <returns>The updated instance; this may be different to the instance argument if
  308. either the original instance was null, or the stream defines a known sub-type of the
  309. original instance.</returns>
  310. </member>
  311. <member name="M:ProtoBuf.Serializer.Serialize``1(System.IO.Stream,``0)">
  312. <summary>
  313. Writes a protocol-buffer representation of the given instance to the supplied stream.
  314. </summary>
  315. <typeparam name="T">The type being serialized.</typeparam>
  316. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  317. <param name="destination">The destination stream to write to.</param>
  318. </member>
  319. <member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0)">
  320. <summary>
  321. Writes a protocol-buffer representation of the given instance to the supplied stream,
  322. with a length-prefix. This is useful for socket programming,
  323. as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object back
  324. from an ongoing stream.
  325. </summary>
  326. <typeparam name="T">The type being serialized.</typeparam>
  327. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  328. <param name="destination">The destination stream to write to.</param>
  329. </member>
  330. <member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle)">
  331. <summary>
  332. Writes a protocol-buffer representation of the given instance to the supplied stream,
  333. with a length-prefix. This is useful for socket programming,
  334. as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object back
  335. from an ongoing stream.
  336. </summary>
  337. <typeparam name="T">The type being serialized.</typeparam>
  338. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  339. <param name="style">How to encode the length prefix.</param>
  340. <param name="destination">The destination stream to write to.</param>
  341. </member>
  342. <member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle,System.Int32)">
  343. <summary>
  344. Writes a protocol-buffer representation of the given instance to the supplied stream,
  345. with a length-prefix. This is useful for socket programming,
  346. as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object back
  347. from an ongoing stream.
  348. </summary>
  349. <typeparam name="T">The type being serialized.</typeparam>
  350. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  351. <param name="style">How to encode the length prefix.</param>
  352. <param name="destination">The destination stream to write to.</param>
  353. <param name="tag">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  354. </member>
  355. <member name="M:ProtoBuf.Serializer.CreateFormatter``1">
  356. <summary>
  357. Creates a new IFormatter that uses protocol-buffer [de]serialization.
  358. </summary>
  359. <typeparam name="T">The type of object to be [de]deserialized by the formatter.</typeparam>
  360. <returns>A new IFormatter to be used during [de]serialization.</returns>
  361. </member>
  362. <member name="M:ProtoBuf.Serializer.Serialize``1(System.Runtime.Serialization.SerializationInfo,``0)">
  363. <summary>
  364. Writes a protocol-buffer representation of the given instance to the supplied SerializationInfo.
  365. </summary>
  366. <typeparam name="T">The type being serialized.</typeparam>
  367. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  368. <param name="info">The destination SerializationInfo to write to.</param>
  369. </member>
  370. <member name="M:ProtoBuf.Serializer.Merge``1(System.Runtime.Serialization.SerializationInfo,``0)">
  371. <summary>
  372. Applies a protocol-buffer from a SerializationInfo to an existing instance.
  373. </summary>
  374. <typeparam name="T">The type being merged.</typeparam>
  375. <param name="instance">The existing instance to be modified (cannot be null).</param>
  376. <param name="info">The SerializationInfo containing the data to apply to the instance (cannot be null).</param>
  377. </member>
  378. <member name="M:ProtoBuf.Serializer.Serialize``1(System.Xml.XmlWriter,``0)">
  379. <summary>
  380. Writes a protocol-buffer representation of the given instance to the supplied XmlWriter.
  381. </summary>
  382. <typeparam name="T">The type being serialized.</typeparam>
  383. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  384. <param name="writer">The destination XmlWriter to write to.</param>
  385. </member>
  386. <member name="M:ProtoBuf.Serializer.Merge``1(System.Xml.XmlReader,``0)">
  387. <summary>
  388. Applies a protocol-buffer from an XmlReader to an existing instance.
  389. </summary>
  390. <typeparam name="T">The type being merged.</typeparam>
  391. <param name="instance">The existing instance to be modified (cannot be null).</param>
  392. <param name="reader">The XmlReader containing the data to apply to the instance (cannot be null).</param>
  393. </member>
  394. <member name="M:ProtoBuf.Serializer.DeepClone``1(``0)">
  395. <summary>
  396. Create a deep clone of the supplied instance; any sub-items are also cloned.
  397. </summary>
  398. <typeparam name="T">The type being cloned.</typeparam>
  399. <param name="instance">The existing instance to be cloned.</param>
  400. <returns>A new copy, cloned from the supplied instance.</returns>
  401. </member>
  402. <member name="M:ProtoBuf.Serializer.ChangeType``2(``0)">
  403. <summary>
  404. Serializes a given instance and deserializes it as a different type;
  405. this can be used to translate between wire-compatible objects (where
  406. two .NET types represent the same data), or to promote/demote a type
  407. through an inheritance hierarchy.
  408. </summary>
  409. <remarks>No assumption of compatibility is made between the types.</remarks>
  410. <typeparam name="TOldType">The type of the object being copied.</typeparam>
  411. <typeparam name="TNewType">The type of the new object to be created.</typeparam>
  412. <param name="instance">The existing instance to use as a template.</param>
  413. <returns>A new instane of type TNewType, with the data from TOldType.</returns>
  414. </member>
  415. <member name="M:ProtoBuf.Serializer.ChangeType``2(``0,ProtoBuf.SerializationContext)">
  416. <summary>
  417. As per the public ChangeType, but allows for workspace-sharing to reduce buffer overhead.
  418. </summary>
  419. </member>
  420. <member name="M:ProtoBuf.Serializer.GetProto``1">
  421. <summary>
  422. Suggest a .proto definition for the given type
  423. </summary>
  424. <typeparam name="T">The type to generate a .proto definition for</typeparam>
  425. <returns>The .proto definition as a string</returns>
  426. </member>
  427. <member name="M:ProtoBuf.Serializer.PrepareSerializer``1">
  428. <summary>
  429. Ensures that the serialization algorithm has been prepared for
  430. the given type; this can be useful in highly threaded code to
  431. ensure that all types are ready ahead of time, avoiding deadlock
  432. scenarios.
  433. </summary>
  434. <typeparam name="T">The object type to prepare.</typeparam>
  435. </member>
  436. <member name="T:ProtoBuf.Serializer.GlobalOptions">
  437. <summary>
  438. Global switches that change the behavior of protobuf-net
  439. </summary>
  440. </member>
  441. <member name="P:ProtoBuf.Serializer.GlobalOptions.InferTagFromName">
  442. <summary>
  443. Global default for that
  444. enables/disables automatic tag generation based on the existing name / order
  445. of the defined members. See <seealso cref="P:ProtoBuf.ProtoContractAttribute.InferTagFromName"/>
  446. for usage and <b>important warning</b> / explanation.
  447. You must set the global default before attempting to serialize/deserialize any
  448. impacted type.
  449. </summary>
  450. </member>
  451. <member name="T:ProtoBuf.Serializer.NonGeneric">
  452. <summary>
  453. Provides non-generic, reflection-based access to Serializer functionality
  454. </summary>
  455. </member>
  456. <member name="M:ProtoBuf.Serializer.NonGeneric.SerializeWithLengthPrefix(System.IO.Stream,System.Object,ProtoBuf.PrefixStyle,System.Int32)">
  457. <summary>
  458. Writes a protocol-buffer representation of the given instance to the supplied stream.
  459. </summary>
  460. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  461. <param name="style">How to encode the length prefix.</param>
  462. <param name="destination">The destination stream to write to.</param>
  463. <param name="tag">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  464. </member>
  465. <member name="M:ProtoBuf.Serializer.NonGeneric.CanSerialize(System.Type)">
  466. <summary>
  467. Can the given type be meaningfully with protobuf-net?
  468. </summary>
  469. </member>
  470. <member name="M:ProtoBuf.Serializer.NonGeneric.Serialize(System.IO.Stream,System.Object)">
  471. <summary>
  472. Writes a protocol-buffer representation of the given instance to the supplied stream.
  473. </summary>
  474. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  475. <param name="destination">The destination stream to write to.</param>
  476. </member>
  477. <member name="M:ProtoBuf.Serializer.NonGeneric.TryDeserializeWithLengthPrefix(System.IO.Stream,ProtoBuf.PrefixStyle,ProtoBuf.Getter{System.Int32,System.Type},System.Object@)">
  478. <summary>
  479. Deserialize object of unknown types from in input stream.
  480. </summary>
  481. <param name="source">The input stream.</param>
  482. <param name="style">The prefix style used to encode the lengths.</param>
  483. <param name="typeReader">The caller must provide a mechanism to resolve a Type from
  484. the tags encountered in the stream. If the delegate returns null, then the instance
  485. is skipped - otherwise, the object is deserialized according to type.</param>
  486. <param name="item">The deserialized instance, or null if the stream terminated.</param>
  487. <returns>True if an object was idenfified; false if the stream terminated. Note
  488. that unexpected types are skipped.</returns>
  489. </member>
  490. <member name="M:ProtoBuf.Serializer.NonGeneric.Deserialize(System.Type,System.IO.Stream)">
  491. <summary>
  492. Creates a new instance from a protocol-buffer stream
  493. </summary>
  494. <param name="type">The type to be created.</param>
  495. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  496. <returns>A new, initialized instance.</returns>
  497. </member>
  498. <member name="M:ProtoBuf.Serializer.NonGeneric.DeepClone(System.Object)">
  499. <summary>
  500. Create a deep clone of the supplied instance; any sub-items are also cloned.
  501. </summary>
  502. <param name="instance">The existing instance to be cloned.</param>
  503. <returns>A new copy, cloned from the supplied instance.</returns>
  504. </member>
  505. <member name="F:ProtoBuf.StreamState.Normal">
  506. <summary>
  507. Indicates that an EOF is not anticipated, and so will throw an exception.
  508. </summary>
  509. </member>
  510. <member name="F:ProtoBuf.StreamState.EofExpected">
  511. <summary>
  512. Indicates that an EOF is acceptable at the current time and will
  513. not throw an exception.
  514. </summary>
  515. </member>
  516. <member name="F:ProtoBuf.StreamState.Peeked">
  517. <summary>
  518. Indicates that we have previously obtained a field value from
  519. the stream that should be consumed next.
  520. </summary>
  521. </member>
  522. <member name="F:ProtoBuf.StreamState.Eof">
  523. <summary>
  524. Indicates that we have found the end of the stream; this is **only**
  525. used to commicate to "Try", and should not persist.
  526. </summary>
  527. </member>
  528. <member name="M:ProtoBuf.SerializationContext.Push(System.Object)">
  529. <summary>
  530. Allows for recursion detection by capturing
  531. the call tree; this only takes effect after
  532. an initial threshold call-depth is reached.
  533. If the object is already in the call-tree,
  534. an exception is thrown.
  535. </summary>
  536. <param name="obj">The item being processed (start).</param>
  537. </member>
  538. <member name="M:ProtoBuf.SerializationContext.Push">
  539. <summary>
  540. Only used during debugging for the text nest-level
  541. </summary>
  542. </member>
  543. <member name="M:ProtoBuf.SerializationContext.Pop">
  544. <summary>
  545. Only used during debugging for the text nest-level
  546. </summary>
  547. </member>
  548. <member name="M:ProtoBuf.SerializationContext.Pop(System.Object)">
  549. <summary>
  550. Removes an object from the call-tree.
  551. </summary>
  552. <remarks>The object is not checked for validity (peformance);
  553. ensure that objects are pushed/popped correctly.</remarks>
  554. <param name="obj">The item being processed (end).</param>
  555. </member>
  556. <member name="M:ProtoBuf.SerializationContext.DecodeUInt32Fixed(System.IO.Stream)">
  557. <summary>
  558. Slow (unbuffered) read from a stream; used to avoid issues
  559. with buffers when performing network IO.
  560. </summary>
  561. </member>
  562. <member name="M:ProtoBuf.SerializationContext.TryDecodeUInt32Fixed(System.IO.Stream,System.UInt32@)">
  563. <summary>
  564. Slow (unbuffered) read from a stream; used to avoid issues
  565. with buffers when performing network IO.
  566. </summary>
  567. </member>
  568. <member name="M:ProtoBuf.SerializationContext.DecodeUInt32(System.IO.Stream)">
  569. <summary>
  570. Slow (unbuffered) read from a stream; used to avoid issues
  571. with buffers when performing network IO.
  572. </summary>
  573. </member>
  574. <member name="M:ProtoBuf.SerializationContext.SkipStringData(System.IO.Stream)">
  575. <summary>
  576. Jump a block of data using a base-128 length prefix.
  577. </summary>
  578. <param name="source">The input stream.</param>
  579. </member>
  580. <member name="M:ProtoBuf.SerializationContext.TryDecodeUInt32(System.IO.Stream,System.UInt32@)">
  581. <summary>
  582. Slow (unbuffered) read from a stream; used to avoid issues
  583. with buffers when performing network IO.
  584. </summary>
  585. <returns>True if there is data in the stream and a value can be obtained;
  586. False if there is no data in the stream; note that an exception is still
  587. thrown if the data is invalid.</returns>
  588. </member>
  589. <member name="M:ProtoBuf.SerializationContext.Fill(System.Int32,System.Boolean)">
  590. <summary>
  591. Fills the IO buffer if there is not enough data buffered to complete the current operation.
  592. </summary>
  593. <param name="required">The maximum number of bytes required by the current operation.</param>
  594. <param name="demand">Should an exception be thrown if the data is not available?</param>
  595. </member>
  596. <member name="M:ProtoBuf.SerializationContext.Fill">
  597. <summary>
  598. Fills the IO buffer, moving any un-consumed data to the beginning of the cache.
  599. </summary>
  600. </member>
  601. <member name="M:ProtoBuf.SerializationContext.Flush(System.Int32)">
  602. <summary>
  603. Flushes the IO buffer if there is not enough space to complete the current operation.
  604. </summary>
  605. <param name="spaceRequired">The maximum number of bytes required by the current operation.</param>
  606. </member>
  607. <member name="M:ProtoBuf.SerializationContext.Flush">
  608. <summary>
  609. Flushes the IO buffer, writing any cached data to the underlying stream and resetting the cache.
  610. </summary>
  611. </member>
  612. <member name="F:ProtoBuf.WireType.Variant">
  613. <summary>
  614. Base-128 variant-length encoding
  615. </summary>
  616. </member>
  617. <member name="F:ProtoBuf.WireType.Fixed64">
  618. <summary>
  619. Fixed-length 8-byte encoding
  620. </summary>
  621. </member>
  622. <member name="F:ProtoBuf.WireType.String">
  623. <summary>
  624. Length-variant-prefixed encoding
  625. </summary>
  626. </member>
  627. <member name="F:ProtoBuf.WireType.StartGroup">
  628. <summary>
  629. Indicates the start of a group
  630. </summary>
  631. </member>
  632. <member name="F:ProtoBuf.WireType.EndGroup">
  633. <summary>
  634. Indicates the end of a group
  635. </summary>
  636. </member>
  637. <member name="F:ProtoBuf.WireType.Fixed32">
  638. <summary>
  639. Fixed-length 4-byte encoding
  640. </summary>
  641. </member>
  642. <member name="T:ProtoBuf.DataFormat">
  643. <summary>
  644. Sub-format to use when serializing/deserializing data
  645. </summary>
  646. </member>
  647. <member name="F:ProtoBuf.DataFormat.Default">
  648. <summary>
  649. Uses the default encoding for the data-type.
  650. </summary>
  651. </member>
  652. <member name="F:ProtoBuf.DataFormat.ZigZag">
  653. <summary>
  654. When applied to signed integer-based data (including Decimal), this
  655. indicates that zigzag variant encoding will be used. This means that values
  656. with small magnitude (regardless of sign) take a small amount
  657. of space to encode.
  658. </summary>
  659. </member>
  660. <member name="F:ProtoBuf.DataFormat.TwosComplement">
  661. <summary>
  662. When applied to signed integer-based data (including Decimal), this
  663. indicates that two's-complement variant encoding will be used.
  664. This means that any -ve number will take 10 bytes (even for 32-bit),
  665. so should only be used for compatibility.
  666. </summary>
  667. </member>
  668. <member name="F:ProtoBuf.DataFormat.FixedSize">
  669. <summary>
  670. When applied to signed integer-based data (including Decimal), this
  671. indicates that a fixed amount of space will be used.
  672. </summary>
  673. </member>
  674. <member name="F:ProtoBuf.DataFormat.Group">
  675. <summary>
  676. When applied to a sub-message, indicates that the value should be treated
  677. as group-delimited.
  678. </summary>
  679. </member>
  680. <member name="T:ProtoBuf.ProtoIncludeAttribute">
  681. <summary>
  682. Indicates the known-types to support for an individual
  683. message. This serializes each level in the hierarchy as
  684. a nested message to retain wire-compatibility with
  685. other protocol-buffer implementations.
  686. </summary>
  687. </member>
  688. <member name="M:ProtoBuf.ProtoIncludeAttribute.#ctor(System.Int32,System.Type)">
  689. <summary>
  690. Creates a new instance of the ProtoIncludeAttribute.
  691. </summary>
  692. <param name="tag">The unique index (within the type) that will identify this data.</param>
  693. <param name="knownType">The additional type to serialize/deserialize.</param>
  694. </member>
  695. <member name="M:ProtoBuf.ProtoIncludeAttribute.#ctor(System.Int32,System.String)">
  696. <summary>
  697. Creates a new instance of the ProtoIncludeAttribute.
  698. </summary>
  699. <param name="tag">The unique index (within the type) that will identify this data.</param>
  700. <param name="knownTypeName">The additional type to serialize/deserialize.</param>
  701. </member>
  702. <member name="P:ProtoBuf.ProtoIncludeAttribute.Tag">
  703. <summary>
  704. Gets the unique index (within the type) that will identify this data.
  705. </summary>
  706. </member>
  707. <member name="P:ProtoBuf.ProtoIncludeAttribute.KnownTypeName">
  708. <summary>
  709. Gets the additional type to serialize/deserialize.
  710. </summary>
  711. </member>
  712. <member name="P:ProtoBuf.ProtoIncludeAttribute.KnownType">
  713. <summary>
  714. Gets the additional type to serialize/deserialize.
  715. </summary>
  716. </member>
  717. <member name="P:ProtoBuf.ProtoIncludeAttribute.DataFormat">
  718. <summary>
  719. Specifies whether the inherited sype's sub-message should be
  720. written with a length-prefix (default), or with group markers.
  721. </summary>
  722. </member>
  723. <member name="T:ProtoBuf.ProtoContractAttribute">
  724. <summary>
  725. Indicates that a type is defined for protocol-buffer serialization.
  726. </summary>
  727. </member>
  728. <member name="P:ProtoBuf.ProtoContractAttribute.Name">
  729. <summary>
  730. Gets or sets the defined name of the type.
  731. </summary>
  732. </member>
  733. <member name="P:ProtoBuf.ProtoContractAttribute.ImplicitFirstTag">
  734. <summary>
  735. Gets or sets the fist offset to use with implicit field tags;
  736. only uesd if ImplicitFields is set.
  737. </summary>
  738. </member>
  739. <member name="P:ProtoBuf.ProtoContractAttribute.ImplicitFields">
  740. <summary>
  741. Gets or sets the mechanism used to automatically infer field tags
  742. for members. This option should be used in advanced scenarios only.
  743. Please review the important notes against the ImplicitFields enumeration.
  744. </summary>
  745. </member>
  746. <member name="P:ProtoBuf.ProtoContractAttribute.InferTagFromName">
  747. <summary>
  748. Enables/disables automatic tag generation based on the existing name / order
  749. of the defined members. This option is not used for members marked
  750. with ProtoMemberAttribute, as intended to provide compatibility with
  751. WCF serialization. WARNING: when adding new fields you must take
  752. care to increase the Order for new elements, otherwise data corruption
  753. may occur.
  754. </summary>
  755. <remarks>If not specified, the default is assumed from <see cref="P:ProtoBuf.Serializer.GlobalOptions.InferTagFromName"/>.</remarks>
  756. </member>
  757. <member name="P:ProtoBuf.ProtoContractAttribute.DataMemberOffset">
  758. <summary>
  759. Specifies an offset to apply to [DataMember(Order=...)] markers;
  760. this is useful when working with mex-generated classes that have
  761. a different origin (usually 1 vs 0) than the original data-contract.
  762. This value is added to the Order of each member.
  763. </summary>
  764. </member>
  765. <member name="T:ProtoBuf.ProtoEnumAttribute">
  766. <summary>
  767. Used to define protocol-buffer specific behavior for
  768. enumerated values.
  769. </summary>
  770. </member>
  771. <member name="M:ProtoBuf.ProtoEnumAttribute.HasValue">
  772. <summary>
  773. Indicates whether this instance has a customised value mapping
  774. </summary>
  775. <returns>true if a specific value is set</returns>
  776. </member>
  777. <member name="P:ProtoBuf.ProtoEnumAttribute.Value">
  778. <summary>
  779. Gets or sets the specific value to use for this enum during serialization.
  780. </summary>
  781. </member>
  782. <member name="P:ProtoBuf.ProtoEnumAttribute.Name">
  783. <summary>
  784. Gets or sets the defined name of the enum, as used in .proto
  785. (this name is not used during serialization).
  786. </summary>
  787. </member>
  788. <member name="T:ProtoBuf.ProtoMemberAttribute">
  789. <summary>
  790. Declares a member to be used in protocol-buffer serialization, using
  791. the given Tag. A DataFormat may be used to optimise the serialization
  792. format (for instance, using zigzag encoding for negative numbers, or
  793. fixed-length encoding for large values.
  794. </summary>
  795. </member>
  796. <member name="M:ProtoBuf.ProtoMemberAttribute.#ctor(System.Int32)">
  797. <summary>
  798. Creates a new ProtoMemberAttribute instance.
  799. </summary>
  800. <param name="tag">Specifies the unique tag used to identify this member within the type.</param>
  801. </member>
  802. <member name="P:ProtoBuf.ProtoMemberAttribute.Name">
  803. <summary>
  804. Gets or sets the original name defined in the .proto; not used
  805. during serialization.
  806. </summary>
  807. </member>
  808. <member name="P:ProtoBuf.ProtoMemberAttribute.DataFormat">
  809. <summary>
  810. Gets or sets the data-format to be used when encoding this value.
  811. </summary>
  812. </member>
  813. <member name="P:ProtoBuf.ProtoMemberAttribute.Tag">
  814. <summary>
  815. Gets the unique tag used to identify this member within the type.
  816. </summary>
  817. </member>
  818. <member name="P:ProtoBuf.ProtoMemberAttribute.IsRequired">
  819. <summary>
  820. Gets or sets a value indicating whether this member is mandatory.
  821. </summary>
  822. </member>
  823. <member name="P:ProtoBuf.ProtoMemberAttribute.Options">
  824. <summary>
  825. Gets or sets a value indicating whether this member is packed (lists/arrays).
  826. </summary>
  827. </member>
  828. <member name="T:ProtoBuf.MemberSerializationOptions">
  829. <summary>
  830. Additional (optional) settings that control serialization of members
  831. </summary>
  832. </member>
  833. <member name="F:ProtoBuf.MemberSerializationOptions.None">
  834. <summary>
  835. Default; no additional options
  836. </summary>
  837. </member>
  838. <member name="F:ProtoBuf.MemberSerializationOptions.Packed">
  839. <summary>
  840. Indicates that repeated elements should use packed (length-prefixed) encoding
  841. </summary>
  842. </member>
  843. <member name="F:ProtoBuf.MemberSerializationOptions.Required">
  844. <summary>
  845. Indicates that the given item is required
  846. </summary>
  847. </member>
  848. <member name="T:ProtoBuf.ProtoPartialMemberAttribute">
  849. <summary>
  850. Declares a member to be used in protocol-buffer serialization, using
  851. the given Tag and MemberName. This allows ProtoMemberAttribute usage
  852. even for partial classes where the individual members are not
  853. under direct control.
  854. A DataFormat may be used to optimise the serialization
  855. format (for instance, using zigzag encoding for negative numbers, or
  856. fixed-length encoding for large values.
  857. </summary>
  858. </member>
  859. <member name="M:ProtoBuf.ProtoPartialMemberAttribute.#ctor(System.Int32,System.String)">
  860. <summary>
  861. Creates a new ProtoMemberAttribute instance.
  862. </summary>
  863. <param name="tag">Specifies the unique tag used to identify this member within the type.</param>
  864. <param name="memberName">Specifies the member to be serialized.</param>
  865. </member>
  866. <member name="P:ProtoBuf.ProtoPartialMemberAttribute.MemberName">
  867. <summary>
  868. The name of the member to be serialized.
  869. </summary>
  870. </member>
  871. <member name="T:ProtoBuf.SubStream">
  872. <summary>
  873. Describes a Stream that wraps an underlying stream but
  874. which limits the length. This is used for processing
  875. length-prefied messages (string wire-type) so that no
  876. complex code is required to manage the end of each
  877. object.
  878. </summary>
  879. </member>
  880. <member name="T:ProtoBuf.ExtensibleUtil">
  881. <summary>
  882. This class acts as an internal wrapper allowing us to do a dynamic
  883. methodinfo invoke; an't put into Serializer as don't want on public
  884. API; can't put into Serializer&lt;T&gt; since we need to invoke
  885. accross classes, which isn't allowed in Silverlight)
  886. </summary>
  887. </member>
  888. <member name="M:ProtoBuf.ExtensibleUtil.GetExtendedValues``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Boolean)">
  889. <summary>
  890. All this does is call GetExtendedValuesTyped with the correct type for "instance";
  891. this ensures that we don't get issues with subclasses declaring conflicting types -
  892. the caller must respect the fields defined for the type they pass in.
  893. </summary>
  894. </member>
  895. <member name="M:ProtoBuf.ExtensibleUtil.GetExtendedValuesTyped``2(``0,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Boolean)">
  896. <summary>
  897. Reads the given value(s) from the instance's stream; the serializer
  898. is inferred from TValue and format. For singletons, each occurrence
  899. is merged [only applies for sub-objects], and the composed
  900. value if yielded once; otherwise ("repeated") each occurrence
  901. is yielded separately.
  902. </summary>
  903. <remarks>Needs to be public to be callable thru reflection in Silverlight</remarks>
  904. </member>
  905. <member name="M:ProtoBuf.ExtensibleUtil.AppendExtendValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Object)">
  906. <summary>
  907. All this does is call AppendExtendValueTyped with the correct type for "instance";
  908. this ensures that we don't get issues with subclasses declaring conflicting types -
  909. the caller must respect the fields defined for the type they pass in.
  910. </summary>
  911. </member>
  912. <member name="M:ProtoBuf.ExtensibleUtil.AppendExtendValueTyped``2(``0,System.Int32,ProtoBuf.DataFormat,``1)">
  913. <summary>
  914. Stores the given value into the instance's stream; the serializer
  915. is inferred from TValue and format.
  916. </summary>
  917. <remarks>Needs to be public to be callable thru reflection in Silverlight</remarks>
  918. </member>
  919. <member name="T:ProtoBuf.ProtoException">
  920. <summary>
  921. Indicates an error during serialization/deserialization of a proto stream.
  922. </summary>
  923. </member>
  924. <member name="M:ProtoBuf.ProtoException.#ctor">
  925. <summary>Creates a new ProtoException instance.</summary>
  926. </member>
  927. <member name="M:ProtoBuf.ProtoException.#ctor(System.String)">
  928. <summary>Creates a new ProtoException instance.</summary>
  929. </member>
  930. <member name="M:ProtoBuf.ProtoException.#ctor(System.String,System.Exception)">
  931. <summary>Creates a new ProtoException instance.</summary>
  932. </member>
  933. <member name="M:ProtoBuf.ProtoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  934. <summary>Creates a new ProtoException instance.</summary>
  935. </member>
  936. <member name="T:ProtoBuf.UnknownType">
  937. <summary>
  938. The (non-extensible) UnknownType is used when deserializing
  939. unexpected groups.
  940. </summary>
  941. </member>
  942. <member name="M:ProtoBuf.AsyncUtility.RunAsync``1(ProtoBuf.AsyncBegin{``0},ProtoBuf.AsyncEnd{``0},System.Action{``0},System.Action{System.Exception})">
  943. <summary>Simplified calling convention for asynchronous Begin/End operations.</summary>
  944. <typeparam name="T">The type of data returned by the async operation.</typeparam>
  945. <param name="begin">The start (Begin*) of the async operation.</param>
  946. <param name="end">The end (End*) of the async operation.</param>
  947. <param name="callback">The operation to perform once the operation has completed and a value received.</param>
  948. <param name="exceptionHandler">Callback to invoke when an excetption is thrown during the async operation.</param>
  949. </member>
  950. <member name="T:ProtoBuf.AsyncBegin`1">
  951. <summary>Defines the start of a Begin/End async operation pair.</summary>
  952. <typeparam name="T">The type of value returned by the async operation.</typeparam>
  953. <param name="operation">The operation to be performed.</param>
  954. <param name="state">User-state to be passed to the operation.</param>
  955. <returns>A token to the async operation.</returns>
  956. </member>
  957. <member name="T:ProtoBuf.AsyncEnd`1">
  958. <summary>Defines the completion callback of a Begin/End async operation pair.</summary>
  959. <typeparam name="T">The type of value returned by the async operation.</typeparam>
  960. <param name="operation">The async operation token.</param>
  961. <returns>The final value of the async operation.</returns>
  962. </member>
  963. <member name="T:ProtoBuf.BufferExtension">
  964. <summary>
  965. Provides a simple buffer-based implementation of an <see cref="T:ProtoBuf.IExtension">extension</see> object.
  966. </summary>
  967. </member>
  968. <member name="T:ProtoBuf.IExtension">
  969. <summary>
  970. Provides addition capability for supporting unexpected fields during
  971. protocol-buffer serialization/deserialization. This allows for loss-less
  972. round-trip/merge, even when the data is not fully understood.
  973. </summary>
  974. </member>
  975. <member name="M:ProtoBuf.IExtension.BeginAppend">
  976. <summary>
  977. Requests a stream into which any unexpected fields can be persisted.
  978. </summary>
  979. <returns>A new stream suitable for storing data.</returns>
  980. </member>
  981. <member name="M:ProtoBuf.IExtension.EndAppend(System.IO.Stream,System.Boolean)">
  982. <summary>
  983. Indicates that all unexpected fields have now been stored. The
  984. implementing class is responsible for closing the stream. If
  985. "commit" is not true the data may be discarded.
  986. </summary>
  987. <param name="stream">The stream originally obtained by BeginAppend.</param>
  988. <param name="commit">True if the append operation completed successfully.</param>
  989. </member>
  990. <member name="M:ProtoBuf.IExtension.BeginQuery">
  991. <summary>
  992. Requests a stream of the unexpected fields previously stored.
  993. </summary>
  994. <returns>A prepared stream of the unexpected fields.</returns>
  995. </member>
  996. <member name="M:ProtoBuf.IExtension.EndQuery(System.IO.Stream)">
  997. <summary>
  998. Indicates that all unexpected fields have now been read. The
  999. implementing class is responsible for closing the stream.
  1000. </summary>
  1001. <param name="stream">The stream originally obtained by BeginQuery.</param>
  1002. </member>
  1003. <member name="M:ProtoBuf.IExtension.GetLength">
  1004. <summary>
  1005. Requests the length of the raw binary stream; this is used
  1006. when serializing sub-entities to indicate the expected size.
  1007. </summary>
  1008. <returns>The length of the binary stream representing unexpected data.</returns>
  1009. </member>
  1010. <member name="T:ProtoBuf.ProtoBeforeSerializationAttribute">
  1011. <summary>Specifies a method on the root-contract in an hierarchy to be invoked before serialization.</summary>
  1012. </member>
  1013. <member name="T:ProtoBuf.ProtoAfterSerializationAttribute">
  1014. <summary>Specifies a method on the root-contract in an hierarchy to be invoked after serialization.</summary>
  1015. </member>
  1016. <member name="T:ProtoBuf.ProtoBeforeDeserializationAttribute">
  1017. <summary>Specifies a method on the root-contract in an hierarchy to be invoked before deserialization.</summary>
  1018. </member>
  1019. <member name="T:ProtoBuf.ProtoAfterDeserializationAttribute">
  1020. <summary>Specifies a method on the root-contract in an hierarchy to be invoked after deserialization.</summary>
  1021. </member>
  1022. <member name="T:ProtoBuf.AsyncResult">
  1023. <summary>
  1024. Represents the function to obtain the return value from an asynchronouse operation;
  1025. comparable to Func&lt;object&gt;.
  1026. </summary>
  1027. </member>
  1028. <member name="T:ProtoBuf.Getter`2">
  1029. <summary>
  1030. Returns the required value from an instance; comparable to Func&lt;TEntity,TValue&gt;
  1031. </summary>
  1032. </member>
  1033. <member name="T:ProtoBuf.Setter`2">
  1034. <summary>
  1035. Assigns the required value to an instance; comparable to Action&lt;TEntity,TValue&gt;.
  1036. </summary>
  1037. </member>
  1038. <member name="T:ProtoBuf.ImplicitFields">
  1039. <summary>
  1040. Specifies the method used to infer field tags for members of the type
  1041. under consideration. Tags are deduced using the invariant alphabetic
  1042. sequence of the members' names; this makes implicit field tags very brittle,
  1043. and susceptible to changes such as field names (normally an isolated
  1044. change).
  1045. </summary>
  1046. </member>
  1047. <member name="F:ProtoBuf.ImplicitFields.None">
  1048. <summary>
  1049. No members are serialized implicitly; all members require a suitable
  1050. attribute such as [ProtoMember]. This is the recmomended mode for
  1051. most scenarios.
  1052. </summary>
  1053. </member>
  1054. <member name="F:ProtoBuf.ImplicitFields.AllPublic">
  1055. <summary>
  1056. Public properties and fields are eligible for implicit serialization;
  1057. this treats the public API as a contract.
  1058. </summary>
  1059. </member>
  1060. <member name="F:ProtoBuf.ImplicitFields.AllFields">
  1061. <summary>
  1062. Public and non-public fields are eligible for implicit serialization;
  1063. this acts as a state/implementation serializer.
  1064. </summary>
  1065. </member>
  1066. <member name="T:ProtoBuf.ObjectFactory`1">
  1067. <summary>
  1068. Abstract object factory, used to negate the need for a ": new()" generic constraint
  1069. on Serializer-of-T.
  1070. </summary>
  1071. <typeparam name="T">The type of object to be created.</typeparam>
  1072. </member>
  1073. <member name="T:ProtoBuf.PrefixStyle">
  1074. <summary>
  1075. Specifies the type of prefix that should be applied to messages.
  1076. </summary>
  1077. </member>
  1078. <member name="F:ProtoBuf.PrefixStyle.None">
  1079. <summary>
  1080. No length prefix is applied to the data; the data is terminated only be the end of the stream.
  1081. </summary>
  1082. </member>
  1083. <member name="F:ProtoBuf.PrefixStyle.Base128">
  1084. <summary>
  1085. A base-128 length prefix is applied to the data (efficient for short messages).
  1086. </summary>
  1087. </member>
  1088. <member name="F:ProtoBuf.PrefixStyle.Fixed32">
  1089. <summary>
  1090. A fixed-length (little-endian) length prefix is applied to the data (useful for compatibility).
  1091. </summary>
  1092. </member>
  1093. <member name="T:ProtoBuf.Property.PropertyEnum`2">
  1094. <summary>
  1095. Property implemenation that handles enum values.
  1096. </summary>
  1097. <remarks>All enum wire-values must be in the Int32 range.</remarks>
  1098. </member>
  1099. <member name="T:ProtoBuf.Property.PropertyFactory">
  1100. <summary>
  1101. Utility class for creating/initializing protobuf-net property
  1102. wrappers.
  1103. </summary>
  1104. </member>
  1105. <member name="M:ProtoBuf.Property.PropertyFactory.GetPassThru``1">
  1106. <summary>
  1107. Returns a Getter&lt;T,T&gt; delegate that simply returns
  1108. the original value. This allows code re-use between
  1109. different implementations.
  1110. </summary>
  1111. <remarks>Originally an anonymous method was used, but
  1112. this proved problematic with the Mono 2.0 compiler.</remarks>
  1113. </member>
  1114. <member name="M:ProtoBuf.Property.PropertyFactory.CreatePassThru``1(System.Int32,ProtoBuf.DataFormat@)">
  1115. <summary>
  1116. Create a simple Property that can be used standalone
  1117. to encode/decode values for the given type.
  1118. </summary>
  1119. </member>
  1120. <member name="M:ProtoBuf.Property.PropertyFactory.Create``1(System.Reflection.MemberInfo)">
  1121. <summary>
  1122. Create a Property based around a class
  1123. member (PropertyInfo/FieldInfo).
  1124. </summary>
  1125. </member>
  1126. <member name="M:ProtoBuf.Property.PropertyFactory.CreateProperty``1(System.Type,ProtoBuf.DataFormat@,ProtoBuf.MemberSerializationOptions)">
  1127. <summary>
  1128. Responsible for deciding how to encode/decode a given data-type; maybe
  1129. not the most elegant solution, but it is simple and quick.
  1130. </summary>
  1131. </member>
  1132. <member name="T:ProtoBuf.Property.PropertyFactory.PassThruCache`1">
  1133. <summary>
  1134. Stores, per T, a pass-thru Getter&lt;T,T&gt; delegate.
  1135. </summary>
  1136. </member>
  1137. <member name="T:ProtoBuf.Property.PropertyMessageString`4">
  1138. <summary>
  1139. Serializes an entity using string (length-prefixed) syntax.
  1140. The high number of type arguments is requird to support ancestral serialization;
  1141. there are 2 use-cases:
  1142. direct: for example, a property (base is the highest contract ancestor; prop = actual = the property-type)
  1143. descendent: used internally to cascade inheritance; prop = base = the parent type, actual = the child type
  1144. </summary>
  1145. <typeparam name="TSource">The type declaring the member</typeparam>
  1146. <typeparam name="TProperty">The defined member-type for accessing data</typeparam>
  1147. <typeparam name="TEntityBase">The base-type to use when verifying / instantiating sub-type instances</typeparam>
  1148. <typeparam name="TEntityActual">The type to use for serialization purposes</typeparam>
  1149. </member>
  1150. <member name="T:ProtoBuf.Property.PropertyMessageGroup`4">
  1151. <summary>
  1152. Serializes an entity using group (delimited) syntax.
  1153. The high number of type arguments is requird to support ancestral serialization;
  1154. there are 2 use-cases:
  1155. direct: for example, a property (base is the highest contract ancestor; prop = actual = the property-type)
  1156. descendent: used internally to cascade inheritance; prop = base = the parent type, actual = the child type
  1157. </summary>
  1158. <typeparam name="TSource">The type declaring the member</typeparam>
  1159. <typeparam name="TProperty">The defined member-type for accessing data</typeparam>
  1160. <typeparam name="TEntityBase">The base-type to use when verifying / instantiating sub-type instances</typeparam>
  1161. <typeparam name="TEntityActual">The type to use for serialization purposes</typeparam>
  1162. </member>
  1163. <member name="T:ProtoBuf.ProtoIgnoreAttribute">
  1164. <summary>
  1165. Indicates that a member should be excluded from serialization; this
  1166. is only normally used when using implict fields.
  1167. </summary>
  1168. </member>
  1169. <member name="T:ProtoBuf.ProtoPartialIgnoreAttribute">
  1170. <summary>
  1171. Indicates that a member should be excluded from serialization; this
  1172. is only normally used when using implict fields. This allows
  1173. ProtoIgnoreAttribute usage
  1174. even for partial classes where the individual members are not
  1175. under direct control.
  1176. </summary>
  1177. </member>
  1178. <member name="M:ProtoBuf.ProtoPartialIgnoreAttribute.#ctor(System.String)">
  1179. <summary>
  1180. Creates a new ProtoPartialIgnoreAttribute instance.
  1181. </summary>
  1182. <param name="memberName">Specifies the member to be ignored.</param>
  1183. </member>
  1184. <member name="P:ProtoBuf.ProtoPartialIgnoreAttribute.MemberName">
  1185. <summary>
  1186. The name of the member to be ignored.
  1187. </summary>
  1188. </member>
  1189. <member name="T:ProtoBuf.ServiceModel.ExceptionEventArgs">
  1190. <summary>
  1191. Represents an exception raised through an event.
  1192. </summary>
  1193. </member>
  1194. <member name="M:ProtoBuf.ServiceModel.ExceptionEventArgs.#ctor(System.Exception)">
  1195. <summary>
  1196. Creates a new instance of ExceptionEventArgs for the gievn exception.
  1197. </summary>
  1198. <param name="exception"></param>
  1199. </member>
  1200. <member name="P:ProtoBuf.ServiceModel.ExceptionEventArgs.Exception">
  1201. <summary>
  1202. The exception represented by the event.
  1203. </summary>
  1204. </member>
  1205. <member name="T:ProtoBuf.ServiceModel.Client.HttpBasicTransport">
  1206. <summary>
  1207. Performs RPC using basic http POSTs to a web-server.
  1208. </summary>
  1209. </member>
  1210. <member name="T:ProtoBuf.ServiceModel.Client.ITransport">
  1211. <summary>
  1212. Provides the underlying transport for a family of RPC operations.
  1213. </summary>
  1214. </member>
  1215. <member name="M:ProtoBuf.ServiceModel.Client.ITransport.SendRequestAsync(ProtoBuf.ServiceModel.Client.ServiceRequest)">
  1216. <summary>
  1217. Begins an async operation over the transport.
  1218. </summary>
  1219. <param name="request">The operation to perform (includes the facility
  1220. to provide a response for the operation).</param>
  1221. </member>
  1222. <member name="M:ProtoBuf.ServiceModel.Client.HttpBasicTransport.#ctor(System.String)">
  1223. <summary>Create a new HttpBasicTransport instance.</summary>
  1224. <param name="uri">The endpoint for the service. By default, the servic
  1225. is assumed to be RESTful, and the action is appended as a route; the
  1226. route can be customized by including the "{action}" token in the uri.</param>
  1227. </member>
  1228. <member name="M:ProtoBuf.ServiceModel.Client.HttpBasicTransport.Dispose">
  1229. <summary>
  1230. Releases any resources associated with the transport.
  1231. </summary>
  1232. </member>
  1233. <member name="M:ProtoBuf.ServiceModel.Client.HttpBasicTransport.Dispose(System.Boolean)">
  1234. <summary>
  1235. Releases any resources associated with the transport.
  1236. </summary>
  1237. </member>
  1238. <member name="M:ProtoBuf.ServiceModel.Client.HttpBasicTransport.CheckDisposed">
  1239. <summary>
  1240. Raises an exception if the instance has been disposed.
  1241. </summary>
  1242. </member>
  1243. <member name="T:ProtoBuf.ServiceModel.RpcUtils">
  1244. <summary>
  1245. Utility operations common to RPC implementations.
  1246. </summary>
  1247. </member>
  1248. <member name="M:ProtoBuf.ServiceModel.RpcUtils.IsRequestArgument(System.Reflection.ParameterInfo)">
  1249. <summary>
  1250. Indicates whether the given parameter forms part of a request - i.e.
  1251. is "in" or "ref".
  1252. </summary>
  1253. <param name="parameter">The parameter to test.</param>
  1254. <returns>True if the given parameter is part of a request.</returns>
  1255. </member>
  1256. <member name="M:ProtoBuf.ServiceModel.RpcUtils.IsResponseArgument(System.Reflection.ParameterInfo)">
  1257. <summary>
  1258. Indicates whether the given parameter forms part of a response - i.e.
  1259. is "out" or "ref".
  1260. </summary>
  1261. <param name="parameter">The parameter to test.</param>
  1262. <returns>True if the given parameter is part of a response.</returns>
  1263. </member>
  1264. <member name="M:ProtoBuf.ServiceModel.RpcUtils.GetServiceName(System.Type)">
  1265. <summary>
  1266. Returns the name associated with a service contract.
  1267. </summary>
  1268. <param name="type">The service-contract type.</param>
  1269. <returns>The name of the service.</returns>
  1270. </member>
  1271. <member name="T:ProtoBuf.ServiceModel.Server.HttpServer">
  1272. <summary>
  1273. Standalone http server compatible with <seealso cref="T:ProtoBuf.ServiceModel.Client.HttpBasicTransport"/>.
  1274. </summary>
  1275. </member>
  1276. <member name="T:ProtoBuf.ServiceModel.Server.ServerBase">
  1277. <summary>
  1278. Provides common functionality required by RPC servers.
  1279. </summary>
  1280. </member>
  1281. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.Add``2">
  1282. <summary>
  1283. Adds a per-call service to the server. An instance of the type will
  1284. be created (and disposed if appropriate) per request.
  1285. </summary>
  1286. <typeparam name="TContract">The type of service-contract to provide.</typeparam>
  1287. <typeparam name="TService">The concrete type that will implement the service.</typeparam>
  1288. </member>
  1289. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.Add``1(``0)">
  1290. <summary>
  1291. Adds a singleton service to the server. All requests will be
  1292. serviced by the supplied instance. This instance will be
  1293. disposed (if appropriate) with the server.
  1294. </summary>
  1295. <typeparam name="T">The type of service to provide.</typeparam>
  1296. </member>
  1297. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.Dispose``1(``0@)">
  1298. <summary>
  1299. Releases and nulls a given field/variable.
  1300. </summary>
  1301. </member>
  1302. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.OnBeforeWriteResponse(System.Object)">
  1303. <summary>
  1304. Performs any pre-response operations required.
  1305. </summary>
  1306. </member>
  1307. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.Execute(System.String,System.String,System.Collections.Specialized.NameValueCollection,System.IO.Stream,System.IO.Stream,System.Object)">
  1308. <summary>
  1309. Performs server-side processing of an action, including deserialization
  1310. of arguments, method-invokation, and serialization of the return value and
  1311. any `out`/`ref` arguments.
  1312. </summary>
  1313. </member>
  1314. <member name="T:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase">
  1315. <summary>
  1316. Represents a service endpoint provided by the server.
  1317. </summary>
  1318. </member>
  1319. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase.GetInstance">
  1320. <summary>
  1321. Obtains the instance representing the service endpoint for a call.
  1322. </summary>
  1323. </member>
  1324. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase.ReleaseInstance(System.Object)">
  1325. <summary>
  1326. Releases the instance representing the service endpoint for a call.
  1327. </summary>
  1328. </member>
  1329. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase.Dispose">
  1330. <summary>
  1331. Releases any resources associated with the endpoint.
  1332. </summary>
  1333. </member>
  1334. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase.#ctor(System.Type)">
  1335. <summary>
  1336. Initialises a new service endpoint for the given service type.
  1337. </summary>
  1338. </member>
  1339. <member name="M:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase.GetAction(System.String)">
  1340. <summary>
  1341. Obtains the method that represents a given action.
  1342. </summary>
  1343. <param name="name">The name of the action.</param>
  1344. <returns>The method that should be invoked.</returns>
  1345. </member>
  1346. <member name="P:ProtoBuf.ServiceModel.Server.ServerBase.ServiceBase.ServiceName">
  1347. <summary>
  1348. The name of the service endpoint.
  1349. </summary>
  1350. </member>
  1351. <member name="M:ProtoBuf.ServiceModel.Server.HttpServer.#ctor(System.String,System.Type,System.Type)">
  1352. <summary>
  1353. Create a new HttpServer instance for the given service-type.
  1354. </summary>
  1355. <param name="uriPrefix">The base uri on which to listen for messages.</param>
  1356. <param name="serviceContractType">The interface that represents the service contract.</param>
  1357. <param name="serviceImplementationType">The concrete type that implements the service contract.</param>
  1358. </member>
  1359. <member name="M:ProtoBuf.ServiceModel.Server.HttpServer.#ctor(System.String)">
  1360. <summary>
  1361. Create a new HttpServer instance for the given service-type.
  1362. </summary>
  1363. <param name="uriPrefix">The base uri on which to listen for messages.</param>
  1364. </member>
  1365. <member name="M:ProtoBuf.ServiceModel.Server.HttpServer.Start">
  1366. <summary>
  1367. Begin listening for messages on the server.
  1368. </summary>
  1369. </member>
  1370. <member name="M:ProtoBuf.ServiceModel.Server.HttpServer.OnBeforeWriteResponse(System.Object)">
  1371. <summary>
  1372. Performs any pre-response operations required.
  1373. </summary>
  1374. </member>
  1375. <member name="M:ProtoBuf.ServiceModel.Server.HttpServer.Close">
  1376. <summary>
  1377. Stop listening for messages on the server, and release
  1378. any associated resources.
  1379. </summary>
  1380. </member>
  1381. <member name="T:ProtoBuf.ServiceModel.Client.ProtoClient`1">
  1382. <summary>
  1383. Provides transport-independent wrapper logic for
  1384. managing RPC calls to the server.
  1385. </summary>
  1386. <typeparam name="TService">The service contract that the client represents.</typeparam>
  1387. </member>
  1388. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.Dispose">
  1389. <summary>
  1390. Releases any resources associated with the client.
  1391. </summary>
  1392. </member>
  1393. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.#ctor(ProtoBuf.ServiceModel.Client.ITransport)">
  1394. <summary>
  1395. Create a new client object.
  1396. </summary>
  1397. <param name="transport">The transport implementation to use.</param>
  1398. </member>
  1399. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.InvokeAsync(System.String,System.Action{ProtoBuf.AsyncResult},System.Object[])">
  1400. <summary>
  1401. Begins an RPC invokation asynchrononously.
  1402. </summary>
  1403. <param name="methodName">The name of the method (on the service interface) to invoke.</param>
  1404. <param name="args">The request payload.</param>
  1405. <param name="callback">The operation to perform when a response is received.</param>
  1406. </member>
  1407. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.Invoke(System.String,System.Object[])">
  1408. <summary>
  1409. Performs an RPC invokation synchrononously.
  1410. </summary>
  1411. <param name="methodName">The name of the method (on the service interface) to invoke.</param>
  1412. <param name="args">The request payload.</param>
  1413. <returns>The response payload.</returns>
  1414. </member>
  1415. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.Invoke(System.Reflection.MethodInfo,System.Object[])">
  1416. <summary>
  1417. Performs an RPC invokation synchrononously.
  1418. </summary>
  1419. <param name="method">The method (on the service interface) to invoke.</param>
  1420. <param name="args">The request payload.</param>
  1421. <returns>The response payload.</returns>
  1422. </member>
  1423. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.InvokeAsync(System.Reflection.MethodInfo,System.Action{ProtoBuf.AsyncResult},System.Object[])">
  1424. <summary>
  1425. Begins an RPC invokation asynchrononously.
  1426. </summary>
  1427. <param name="method">The method (on the service interface) to invoke.</param>
  1428. <param name="args">The request payload.</param>
  1429. <param name="callback">The operation to perform when a response is received.</param>
  1430. </member>
  1431. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.ResolveAction(System.Reflection.MethodInfo)">
  1432. <summary>
  1433. Identify the action to use for a given method.
  1434. </summary>
  1435. <param name="method">The method requested.</param>
  1436. <returns>The action to use.</returns>
  1437. </member>
  1438. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.ResolveService(System.Type)">
  1439. <summary>
  1440. Identify the service to use for a given method.
  1441. </summary>
  1442. <param name="serviceType">The service requested.</param>
  1443. <returns>The service to use.</returns>
  1444. </member>
  1445. <member name="M:ProtoBuf.ServiceModel.Client.ProtoClient`1.OnException(System.Exception)">
  1446. <summary>
  1447. Signals that an error occured processing RPC calls.
  1448. </summary>
  1449. <param name="exception">The error details.</param>
  1450. </member>
  1451. <member name="P:ProtoBuf.ServiceModel.Client.ProtoClient`1.Timeout">
  1452. <summary>
  1453. Gets or sets the timeout (in milliseconds) for synchronous RPC operations.
  1454. </summary>
  1455. </member>
  1456. <member name="P:ProtoBuf.ServiceModel.Client.ProtoClient`1.Transport">
  1457. <summary>
  1458. Gets the transport mechanism associated with the client.
  1459. </summary>
  1460. </member>
  1461. <member name="E:ProtoBuf.ServiceModel.Client.ProtoClient`1.ServiceException">
  1462. <summary>
  1463. Raised when an error occurs processing RPC calls.
  1464. </summary>
  1465. </member>
  1466. <member name="T:ProtoBuf.ServiceModel.Client.ServiceRequest">
  1467. <summary>
  1468. Represents an in-progress request (and response mechanism)
  1469. for a basic RPC stack.
  1470. </summary>
  1471. </member>
  1472. <member name="M:ProtoBuf.ServiceModel.Client.ServiceRequest.OnException(System.Exception)">
  1473. <summary>Called by transports; signals that the operation failed.</summary>
  1474. <param name="exception">The details of the failure.</param>
  1475. </member>
  1476. <member name="M:ProtoBuf.ServiceModel.Client.ServiceRequest.OnResponse(System.Object)">
  1477. <summary>Called by transports; signals that the operation succeeded.</summary>
  1478. <param name="responseObject">The server's response the the request.</param>
  1479. </member>
  1480. <member name="M:ProtoBuf.ServiceModel.Client.ServiceRequest.#ctor(System.String,System.String,System.Reflection.MethodInfo,System.Object[],System.Object,System.Action{ProtoBuf.AsyncResult})">
  1481. <summary>Create a new service request.</summary>
  1482. <param name="action">The contract-based name of the operation to perform.</param>
  1483. <param name="service">The contract-based name of the service to use.</param>
  1484. <param name="method">Provides reflection access to the contract member representing the operation.</param>
  1485. <param name="args">The argument values for the method.</param>
  1486. <param name="userState">Caller-defined state for this operation.</param>
  1487. <param name="callback">The operation to perform when this request has completed.</param>
  1488. </member>
  1489. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.UserState">
  1490. <summary>Caller-defined state for this operation.</summary>
  1491. </member>
  1492. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.Args">
  1493. <summary>The object graph representing the query request object.</summary>
  1494. </member>
  1495. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.ResponseObject">
  1496. <summary>The object graph representing the server's response.</summary>
  1497. </member>
  1498. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.Exception">
  1499. <summary> Descripbes any exception raised by the transport.</summary>
  1500. </member>
  1501. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.Action">
  1502. <summary>The contract-based name of the operation to perform.</summary>
  1503. </member>
  1504. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.Service">
  1505. <summary>The contract-based name of the service to ues.</summary>
  1506. </member>
  1507. <member name="P:ProtoBuf.ServiceModel.Client.ServiceRequest.Method">
  1508. <summary>Provides reflection access to the contract member representing the operation.</summary>
  1509. </member>
  1510. </members>
  1511. </doc>