go.uber.org/cadence@v1.2.9/encoded/encoded.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  // Package encoded contains wrappers that are used for binary payloads deserialization.
    22  package encoded
    23  
    24  import "go.uber.org/cadence/internal"
    25  
    26  type (
    27  
    28  	// Value is used to encapsulate/extract encoded value from workflow/activity.
    29  	Value = internal.Value
    30  
    31  	// Values is used to encapsulate/extract encoded one or more values from workflow/activity.
    32  	Values = internal.Values
    33  
    34  	// DataConverter is used by the framework to serialize/deserialize input and output of activity/workflow
    35  	// that need to be sent over the wire.
    36  	// To encode/decode workflow arguments, one should set DataConverter in two places:
    37  	//   1. Workflow worker, through worker.Options
    38  	//   2. Client, through client.Options
    39  	// To encode/decode Activity/ChildWorkflow arguments, one should set DataConverter in two places:
    40  	//   1. Inside workflow code, use workflow.WithDataConverter to create new Context,
    41  	// and pass that context to ExecuteActivity/ExecuteChildWorkflow calls.
    42  	// Cadence support using different DataConverters for different activity/childWorkflow in same workflow.
    43  	//   2. Activity/Workflow worker that run these activity/childWorkflow, through worker.Options.
    44  	DataConverter = internal.DataConverter
    45  )
    46  
    47  // GetDefaultDataConverter return default data converter used by Cadence worker
    48  func GetDefaultDataConverter() DataConverter {
    49  	return internal.DefaultDataConverter
    50  }