Skip to content

Commit 2c7a81f

Browse files
author
Isaac Andrade
committed
Fix typos.
- doc.go has grammar correction and minor changes to assist users in reading. It is better to mention the name of the method in the usage documentation so users know the text they are reading belong to the example code above (or below) by their method name. - message_router.go has grammar correction. - _gen/generate-messages/main.go has a typo fix that propagated when code generation was ran.
1 parent 012a57a commit 2c7a81f

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

_gen/generate-messages/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func genMessages() {
4141

4242
func genMessageImports() string {
4343
fileOut := `
44-
import(
44+
import(
4545
"github.com/quickfixgo/quickfix"
4646
"github.com/quickfixgo/quickfix/enum"
4747
`
@@ -247,7 +247,7 @@ func genMessageRoute(msg *datadictionary.MessageDef) string {
247247
//A RouteOut is the callback type that should be implemented for routing Message
248248
type RouteOut func(msg Message, sessionID quickfix.SessionID) quickfix.MessageRejectError
249249
250-
//Route returns the beginstring, message type, and MessageRoute for this Mesage type
250+
//Route returns the beginstring, message type, and MessageRoute for this Message type
251251
func Route(router RouteOut) (string,string,quickfix.MessageRoute) {
252252
r:=func(msg quickfix.Message, sessionID quickfix.SessionID) quickfix.MessageRejectError {
253253
m:=new(Message)

doc.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,35 @@ Creating your QuickFIX Application
55
66
Creating a FIX application is as easy as implementing the QuickFIX Application interface. By implementing these interface methods in your derived type, you are requesting to be notified of events that occur on the FIX engine. The function that you should be most aware of is fromApp.
77
8-
Here are explanations of what these functions provide for you.
8+
Here are explanations of what these callback functions provide for you.
99
1010
OnCreate(sessionID SessionID)
1111
12-
This method is called when quickfix creates a new session. A session comes into and remains in existence for the life of the application. Sessions exist whether or not a counter party is connected to it. As soon as a session is created, you can begin sending messages to it. If no one is logged on, the messages will be sent at the time a connection is established with the counterparty.
12+
OnCreate is called when quickfix creates a new session. A session comes into and remains in existence for the life of the application. Sessions exist whether or not a counter party is connected to it. As soon as a session is created, you can begin sending messages to it. If no one is logged on, the messages will be sent at the time a connection is established with the counterparty.
1313
1414
OnLogon(sessionID SessionID)
1515
16-
This callback notifies you when a valid logon has been established with a counter party. This is called when a connection has been established and the FIX logon process has completed with both parties exchanging valid logon messages.
16+
OnLogon notifies you when a valid logon has been established with a counter party. This is called when a connection has been established and the FIX logon process has completed with both parties exchanging valid logon messages.
1717
1818
OnLogout(sessionID SessionID)
1919
20-
This callback notifies you when an FIX session is no longer online. This could happen during a normal logout exchange or because of a forced termination or a loss of network connection.
20+
OnLogout notifies you when an FIX session is no longer online. This could happen during a normal logout exchange or because of a forced termination or a loss of network connection.
2121
2222
ToAdmin(message Message, sessionID SessionID)
2323
24-
This callback provides you with a peak at the administrative messages that are being sent from your FIX engine to the counter party. This is normally not useful for an application however it is provided for any logging you may wish to do. Notice that the Message is not const. This allows you to add fields before an adminstrative message before it is sent out.
24+
ToAdmin provides you with a peak at the administrative messages that are being sent from your FIX engine to the counter party. This is normally not useful for an application however it is provided for any logging you may wish to do. Notice that the Message is not const. This allows you to add fields before an adminstrative message is sent out.
2525
2626
ToApp(message Message, sessionID SessionID) error
2727
28-
This is a callback for application messages that you are being sent to a counterparty. Notice that the Message is not const. This allows you to add fields before an application message before it is sent out.
28+
ToApp notifies you of application messages that you are being sent to a counterparty. Notice that the Message is not const. This allows you to add fields before an application message before it is sent out.
2929
3030
FromAdmin(message Message, sessionID SessionID) MessageRejectError
3131
32-
This callback notifies you when an administrative message is sent from a counterparty to your FIX engine. This can be usefull for doing extra validation on logon messages such as for checking passwords.
32+
FromAdmin notifies you when an administrative message is sent from a counterparty to your FIX engine. This can be usefull for doing extra validation on logon messages such as for checking passwords.
3333
3434
FromApp(msg Message, sessionID SessionID) MessageRejectError
3535
36-
This is one of the core entry points for your FIX application. Every application level request will come through here. If, for example, your application is a sell-side OMS, this is where you will get your new order requests. If you were a buy side, you would get your execution reports here.
36+
FromApp is one of the core entry points for your FIX application. Every application level request will come through here. If, for example, your application is a sell-side OMS, this is where you will get your new order requests. If you were a buy side, you would get your execution reports here.
3737
3838
The sample code below shows how you might start up a FIX acceptor which listens on a socket. If you wanted an initiator, you would simply replace NewAcceptor in this code fragment with NewInitiator.
3939

message_router.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ type routeKey struct {
99
MsgType string
1010
}
1111

12-
//A MessageRoute is a function can process a fromApp/fromAdmin callback
12+
//A MessageRoute is a function that can process a fromApp/fromAdmin callback
1313
type MessageRoute func(msg Message, sessionID SessionID) MessageRejectError
1414

1515
//A MessageRouter is a mutex for MessageRoutes

0 commit comments

Comments
 (0)