mirror of
https://github.com/tmrts/go-patterns.git
synced 2024-11-21 20:46:08 +03:00
Marking undone pattern documentation as TODO and moving files to match naming conventions.
This commit is contained in:
parent
3d2d78a8a2
commit
64a675764a
86
README.md
86
README.md
@ -15,63 +15,63 @@ __Creational Patterns__:
|
|||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Abstract Factory](abstract_factory.go) | Provides an interface for creating families of releated objects |
|
| TODO: [Abstract Factory](creational/abstract_factory.md) | Provides an interface for creating families of releated objects |
|
||||||
| [Builder](builder/builder.go) | Builds a complex object using simple objects |
|
| TODO: [Builder](creational/builder.md) | Builds a complex object using simple objects |
|
||||||
| [Factory Method](factory_method.go) | Defers instantiation of an object to a specialized function for creating instances |
|
| TODO: [Factory Method](creational/factory.md) | Defers instantiation of an object to a specialized function for creating instances |
|
||||||
| [Object Pool](object_pool/pool.go) | Instantiates and maintains a group of objects instances of the same type |
|
| TODO: [Object Pool](creational/object_pool.gp) | Instantiates and maintains a group of objects instances of the same type |
|
||||||
| [Singleton](creational/singleton.md) | Restricts instantiation of a type to one object |
|
| [Singleton](creational/singleton.md) | Restricts instantiation of a type to one object |
|
||||||
|
|
||||||
__Structural Patterns__:
|
__Structural Patterns__:
|
||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Adapter](adapter.go) | Adapts otherwise incompatible interfaces to work together by adapting one to the other |
|
| TODO: [Adapter](structural/.md) | Adapts otherwise incompatible interfaces to work together by adapting one to the other |
|
||||||
| [Bridge](bridge.go) | Decouples an interface from its implementation so that the two can vary independently |
|
| TODO: [Bridge](structural/bridge.md) | Decouples an interface from its implementation so that the two can vary independently |
|
||||||
| [Composite](composite.go) | Encapsulates and provides access to a number of different objects |
|
| TODO: [Composite](structural/composite.md) | Encapsulates and provides access to a number of different objects |
|
||||||
| [Decorator](structural/decorator.md) | Adds behavior to an object, statically or dynamically |
|
| [Decorator](structural/decorator.md) | Adds behavior to an object, statically or dynamically |
|
||||||
| [Facade](facade.go) | Uses one type as an API to a number of others |
|
| TODO: [Facade](structural/facade.md) | Uses one type as an API to a number of others |
|
||||||
| [Flyweight](flyweight.go) | Reuses existing instances of objects with similar/identical state to minimize resource usage |
|
| TODO: [Flyweight](structural/flyweight.md) | Reuses existing instances of objects with similar/identical state to minimize resource usage |
|
||||||
| [Model View Controller](mvc.go) | Divides an app into three interconnected parts to separate internal representation from presentation to user |
|
| TODO: [Model View Controller](structural/model_view_controller.md) | Divides an app into three interconnected parts to separate internal representation from presentation to user |
|
||||||
| [Proxy](proxy.go) | Provides a surrogate for an object to control it's actions |
|
| TODO: [Proxy](structural/proxy.md) | Provides a surrogate for an object to control it's actions |
|
||||||
|
|
||||||
__Behavioral Patterns__:
|
__Behavioral Patterns__:
|
||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Chain of Responsibility](chain_of_responsibility.go) | Avoids coupling a sender to receiver by giving more than object a chance to handle the request |
|
| TODO: [Chain of Responsibility](behavioral/chain_of_responsibility.md) | Avoids coupling a sender to receiver by giving more than object a chance to handle the request |
|
||||||
| [Command](command.go) | Bundles a command and arguments to call later |
|
| TODO: [Command](behavioral/command.md) | Bundles a command and arguments to call later |
|
||||||
| [Mediator](mediator.go) | Connects objects and acts as a proxy |
|
| TODO: [Mediator](behavioral/mediator.md) | Connects objects and acts as a proxy |
|
||||||
| [Memento](memento.go) | Generate an opaque token that can be used to go back to a previous state |
|
| TODO: [Memento](behavioral/memento.md) | Generate an opaque token that can be used to go back to a previous state |
|
||||||
| [Observer](observer.go) | Provide a callback for notification of events/changes to data |
|
| TODO: [Observer](behavioral/observer.md) | Provide a callback for notification of events/changes to data |
|
||||||
| [Registry](registry.go) | Keep track of all subclasses of a given class |
|
| TODO: [Registry](behavioral/registry.md) | Keep track of all subclasses of a given class |
|
||||||
| [State](state.go) | Encapsulates varying behavior for the same object based on its internal state |
|
| TODO: [State](behavioral/state.md) | Encapsulates varying behavior for the same object based on its internal state |
|
||||||
| [Strategy](behavioral/strategy.md) | Enables an algorithm's behavior to be selected at runtime |
|
| [Strategy](behavioral/strategy.md) | Enables an algorithm's behavior to be selected at runtime |
|
||||||
| [Template](template.go) | Defines a skeleton class which defers some methods to subclasses |
|
| TODO: [Template](behavioral/template.md) | Defines a skeleton class which defers some methods to subclasses |
|
||||||
| [Visitor](visitor.go) | Separates an algorithm from an object on which it operates |
|
| TODO: [Visitor](behavioral/visitor.md) | Separates an algorithm from an object on which it operates |
|
||||||
|
|
||||||
__Synchronization Patterns__:
|
__Synchronization Patterns__:
|
||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Condition Variable](condition_variable.go) | Provides a mechanism for threads to temporarily give up access in order to wait for some condition |
|
| TODO: [Condition Variable](synchronization/condition_variable.md) | Provides a mechanism for threads to temporarily give up access in order to wait for some condition |
|
||||||
| [Lock/Mutex](mutex/mutex.go) | Enforces mutual exclusion limit on a resource to gain exclusive access |
|
| TODO: [Lock/Mutex](synchronization/mutex.md) | Enforces mutual exclusion limit on a resource to gain exclusive access |
|
||||||
| [Monitor](monitor.go) | Combination of mutex and condition variable patterns |
|
| TODO: [Monitor](synchronization/monitor.md) | Combination of mutex and condition variable patterns |
|
||||||
| [Read-Write Lock](read_write_lock.go) | Allows parallel read access, but only exclusive access on write operations to a resource |
|
| TODO: [Read-Write Lock](synchronization/read_write_lock.md) | Allows parallel read access, but only exclusive access on write operations to a resource |
|
||||||
| [Semaphore](synchronization/semaphore.md) | Allows controlling access to a common resource |
|
| [Semaphore](synchronization/semaphore.md) | Allows controlling access to a common resource |
|
||||||
|
|
||||||
__Concurrency Patterns__:
|
__Concurrency Patterns__:
|
||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [N-Barrier](barrier.go) | Prevents a process from proceeding until all N processes reach to the barrier |
|
| TODO: [N-Barrier](concurrency/barrier.md) | Prevents a process from proceeding until all N processes reach to the barrier |
|
||||||
| [Bounded Parallelism](bounded_parallelism/md5.go) | Completes large number of indenpendent tasks with resource limits |
|
| [Bounded Parallelism](concurrency/bounded_parallelism.md) | Completes large number of indenpendent tasks with resource limits |
|
||||||
| [Broadcast](broadcast.go) | Transfers a message to all recipients simultaneously |
|
| TODO: [Broadcast](concurrency/broadcast.md) | Transfers a message to all recipients simultaneously |
|
||||||
| [Coroutines](coroutine/coroutine.go) | Subroutines that allow suspending and resuming execution at certain locations |
|
| TODO: [Coroutines](concurrency/coroutine.md) | Subroutines that allow suspending and resuming execution at certain locations |
|
||||||
| [Generators](generator.go) | Yields a sequence of values one at a time |
|
| TODO: [Generators](concurrency/generator.md) | Yields a sequence of values one at a time |
|
||||||
| [Reactor](reactor.go) | Demultiplexes service requests delivered concurrently to a service handler and dispatches them syncronously to the associated request handlers |
|
| TODO: [Reactor](concurrency/reactor.md) | Demultiplexes service requests delivered concurrently to a service handler and dispatches them syncronously to the associated request handlers |
|
||||||
| [Parallelism](parallelism/md5.go) | Completes large number of indenpendent tasks |
|
| [Parallelism](concurrency/parallelism.md) | Completes large number of indenpendent tasks |
|
||||||
| [Producer Consumer](producer_consumer.go) | Separates tasks from task executions |
|
| TODO: [Producer Consumer](concurrency/producer_consumer.md) | Separates tasks from task executions |
|
||||||
| [Scheduler](scheduler.go) | Orchestrates steps to be performed as part of a task |
|
| TODO: [Scheduler](concurrency/scheduler.md) | Orchestrates steps to be performed as part of a task |
|
||||||
|
|
||||||
__Messaging Patterns__:
|
__Messaging Patterns__:
|
||||||
|
|
||||||
@ -79,26 +79,26 @@ __Messaging Patterns__:
|
|||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Fan-In](messaging/fan_in.md) | Funnels tasks to a work sink (e.g. server) |
|
| [Fan-In](messaging/fan_in.md) | Funnels tasks to a work sink (e.g. server) |
|
||||||
| [Fan-Out](messaging/fan_out.md) | Distributes tasks amongs workers (e.g. producer) |
|
| [Fan-Out](messaging/fan_out.md) | Distributes tasks amongs workers (e.g. producer) |
|
||||||
| [Futures & Promises](futures_promises.go) | Acts as a place-holder of a result that is initally unknown for synchronization purposes |
|
| TODO: [Futures & Promises](messaging/futures_promises.md) | Acts as a place-holder of a result that is initally unknown for synchronization purposes |
|
||||||
| [Publish/Subscribe](messaging/publish_subscribe.md) | Passes information to a collection of recipients who subscribed to a topic |
|
| [Publish/Subscribe](messaging/publish_subscribe.md) | Passes information to a collection of recipients who subscribed to a topic |
|
||||||
| [Push & Pull](push_pull.go) | Distributes messages to multiple workers, arranged in a pipeline |
|
| TODO: [Push & Pull](messaging/push_pull.md) | Distributes messages to multiple workers, arranged in a pipeline |
|
||||||
|
|
||||||
__Stability Patterns__:
|
__Stability Patterns__:
|
||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Bulkheads](bulkhead.go) | Enforces a principle of failure containment (i.e. prevents cascading failures) |
|
| TODO: [Bulkheads](stability/bulkhead.md) | Enforces a principle of failure containment (i.e. prevents cascading failures) |
|
||||||
| [Circuit-Breaker](circuitbreaker/circuit_breaker.go) | Stops the flow of the requests when requests are likely to fail |
|
| [Circuit-Breaker](stability/circuit_breaker.go) | Stops the flow of the requests when requests are likely to fail |
|
||||||
| [Deadline](deadline.go) | Allows clients to stop waiting for a response once the probability of response becomes low (e.g. after waiting 10 seconds for a page refresh)|
|
| TODO: [Deadline](stability/deadline.md) | Allows clients to stop waiting for a response once the probability of response becomes low (e.g. after waiting 10 seconds for a page refresh)|
|
||||||
| [Fail-Fast](fail_fast.go) | Checks the availability of required resources at the start of a request and fails if the requirements are not satisfied |
|
| TODO: [Fail-Fast](stability/fail_fast.md) | Checks the availability of required resources at the start of a request and fails if the requirements are not satisfied |
|
||||||
| [Handshaking](handshaking.go) | Asks a component if it can take any more load, if it can't the request is declined |
|
| TODO: [Handshaking](stability/handshaking.md) | Asks a component if it can take any more load, if it can't the request is declined |
|
||||||
| [Steady-State](steady_state.go) | For every service that accumulates a resource, some other service must recycle that resource |
|
| TODO: [Steady-State](stability/steady_state.md) | For every service that accumulates a resource, some other service must recycle that resource |
|
||||||
|
|
||||||
__Profiling Patterns__:
|
__Profiling Patterns__:
|
||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Timing Functions](timing.go) | Wraps a function and logs the execution |
|
| TODO: [Timing Functions](profiling/timing.md) | Wraps a function and logs the execution |
|
||||||
|
|
||||||
__Idioms__:
|
__Idioms__:
|
||||||
|
|
||||||
@ -110,7 +110,7 @@ __Anti-Patterns__:
|
|||||||
|
|
||||||
| Pattern | Description |
|
| Pattern | Description |
|
||||||
|:-------:| ----------- |
|
|:-------:| ----------- |
|
||||||
| [Cascading Failures]() | A failure in a system of interconnected parts in which the failure of a part causes a domino effect |
|
| TODO: [Cascading Failures](antipatterns/cascading_failures.md) | A failure in a system of interconnected parts in which the failure of a part causes a domino effect |
|
||||||
|
|
||||||
__Other Patterns__:
|
__Other Patterns__:
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user