{"id":170,"date":"2007-03-06T10:54:02","date_gmt":"2007-03-06T17:54:02","guid":{"rendered":"http:\/\/kennyw.com\/indigo\/170"},"modified":"2007-03-06T10:54:02","modified_gmt":"2007-03-06T17:54:02","slug":"boilerplate-code-for-custom-encoder-binding-elements","status":"publish","type":"post","link":"https:\/\/kennyw.com\/?p=170","title":{"rendered":"Boilerplate code for custom Encoder Binding Elements"},"content":{"rendered":"

Part of the process involved in writing a custom MessageEncoder<\/code> is hooking your encoder up to a binding stack. This is accomplished using a subclass of MessageEncodingBindingElement<\/code>. The way our build process works is that we will take the first BindingElement within a Binding, and call [Can]CreateChannel[Factory|Listener]() on it. By default, these 4 calls will simply delegate to the BindingElement “below” them in the stack.<\/p>\n

This default behavior is not exactly what you want in your MessageEncodingBindingElement. While most binding elements add an item to the channel stack, Message Encoders are an “adjunct” binding element. That is, they provide parameters to other binding elements (in this case the transport). The way that parameters are provided to other parts of the build process is through BindingParameters<\/code>. For example, a MessageEncodingBindingElement can add itself to the BindingParameters collection:<\/p>\n

context.BindingParameters.Add(<\/code>this<\/code>);<\/p>\n

And later the TransportBindingElement can fish out the encoder when it is building the relevant factory\/listener:<\/p>\n

Collection<\/code><<\/code>MessageEncodingBindingElement<\/code>>messageEncoderBindingElements
\n = context.BindingParameters.FindAll<<\/code>MessageEncodingBindingElement<\/code>>();<\/code><\/p>\n

Unfortunately, the base MessageEncodingBindingElement<\/code> does not take care of adding itself to the BindingParameters collection in its default [Can]Build methods. Therefore, every<\/strong> subclass needs to add the following four boilerplate overrides. Furthermore, it will be a breaking change to fix this in V2, so it’s unclear if we will be able to fix this in the next release \ud83d\ude41<\/p>\n

public override <\/code>IChannelFactory<\/code><TChannel> BuildChannelFactory<TChannel>(<\/code>BindingContext<\/code> context)
\n {
\n  <\/code>if<\/code> (context == <\/code>null<\/code>)
\n  {
\n    <\/code>throw new <\/code>ArgumentNullException<\/code>(\"context\");
\n  }<\/p>\n

  context.BindingParameters.Add(<\/code>this<\/code>);
\n  <\/code>return<\/code> context.BuildInnerChannelFactory<TChannel>();
\n }<\/p>\n

<\/code>public override <\/code>IChannelListener<\/code><TChannel> BuildChannelListener<TChannel>(<\/code>BindingContext<\/code> context)
\n {
\n  <\/code>if<\/code> (context == <\/code>null<\/code>)
\n  {
\n    <\/code>throw new <\/code>ArgumentNullException<\/code>(\"context\");
\n  }<\/p>\n

  context.BindingParameters.Add(<\/code>this<\/code>);
\n  <\/code>return<\/code> context.BuildInnerChannelListener<TChannel>();
\n }<\/p>\n

<\/code>public override <\/code>bool<\/code> CanBuildChannelFactory<TChannel>(<\/code>BindingContext<\/code> context)
\n {
\n  <\/code>if<\/code> (context == <\/code>null<\/code>)
\n  {
\n    <\/code>throw new <\/code>ArgumentNullException<\/code>(\"context\");
\n  }<\/p>\n

  context.BindingParameters.Add(<\/code>this<\/code>);
\n  <\/code>return<\/code> context.CanBuildInnerChannelFactory<TChannel>();
\n }<\/p>\n

<\/code>public override <\/code>bool<\/code> CanBuildChannelListener<TChannel>(<\/code>BindingContext<\/code> context)
\n {
\n  <\/code>if<\/code> (context == <\/code>null<\/code>)
\n  {
\n    <\/code>throw new <\/code>ArgumentNullException<\/code>(\"context\");
\n  }<\/p>\n

  context.BindingParameters.Add(<\/code>this<\/code>);
\n  <\/code>return<\/code> context.CanBuildInnerChannelListener<TChannel>();
\n }
\n<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"

Part of the process involved in writing a custom MessageEncoder is hooking your encoder up to a binding stack. This is accomplished using a subclass of MessageEncodingBindingElement. The way our build process works is that we will take the first BindingElement within a Binding, and call [Can]CreateChannel[Factory|Listener]() on it. By default, these 4 calls will […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11],"tags":[],"class_list":["post-170","post","type-post","status-publish","format-standard","hentry","category-indigo"],"_links":{"self":[{"href":"https:\/\/kennyw.com\/index.php?rest_route=\/wp\/v2\/posts\/170","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kennyw.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kennyw.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kennyw.com\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/kennyw.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=170"}],"version-history":[{"count":0,"href":"https:\/\/kennyw.com\/index.php?rest_route=\/wp\/v2\/posts\/170\/revisions"}],"wp:attachment":[{"href":"https:\/\/kennyw.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=170"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kennyw.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=170"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kennyw.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=170"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}